Refactor path parser to a separate file

Change-Id: I147d495470d29b41ffaa9c727eff02afe4c0ef34
diff --git a/src/common_parsers.hpp b/src/common_parsers.hpp
index bab3886..eac8e61 100644
--- a/src/common_parsers.hpp
+++ b/src/common_parsers.hpp
@@ -11,6 +11,13 @@
 x3::rule<module_identifier_class, std::string> const module_identifier = "module_identifier";
 x3::rule<module_class, module_> const module = "module";
 x3::rule<node_identifier_class, std::string> const node_identifier = "node_identifier";
+x3::rule<space_separator_class, x3::unused_type> const space_separator = "a space";
+x3::rule<completing_class, x3::unused_type> const completing = "completing";
+
+// This is a pseudo-parser, that fails if we're not completing a command
+auto const completing_def =
+    x3::no_skip[x3::eps];
+
 auto const node_identifier_def =
     x3::lexeme[
             ((x3::alpha | x3::char_("_")) >> *(x3::alnum | x3::char_("_") | x3::char_("-") | x3::char_(".")))
@@ -24,6 +31,11 @@
             ((x3::alpha | x3::char_("_")) >> *(x3::alnum | x3::char_("_") | x3::char_("-") | x3::char_(".")))
     ];
 
+auto const space_separator_def =
+    x3::omit[x3::no_skip[x3::space]];
+
 BOOST_SPIRIT_DEFINE(node_identifier)
 BOOST_SPIRIT_DEFINE(module)
 BOOST_SPIRIT_DEFINE(module_identifier)
+BOOST_SPIRIT_DEFINE(space_separator)
+BOOST_SPIRIT_DEFINE(completing)
diff --git a/src/grammars.hpp b/src/grammars.hpp
index 66fcfb3..dfb8c10 100644
--- a/src/grammars.hpp
+++ b/src/grammars.hpp
@@ -13,31 +13,9 @@
 #include "ast_handlers.hpp"
 #include "common_parsers.hpp"
 #include "leaf_data.hpp"
+#include "path_parser.hpp"
 
 
-x3::rule<keyValue_class, keyValue_> const keyValue = "keyValue";
-x3::rule<key_identifier_class, std::string> const key_identifier = "key_identifier";
-x3::rule<listPrefix_class, std::string> const listPrefix = "listPrefix";
-x3::rule<listSuffix_class, std::vector<keyValue_>> const listSuffix = "listSuffix";
-x3::rule<listElement_class, listElement_> const listElement = "listElement";
-x3::rule<list_class, list_> const list = "list";
-x3::rule<nodeup_class, nodeup_> const nodeup = "nodeup";
-x3::rule<container_class, container_> const container = "container";
-x3::rule<leaf_class, leaf_> const leaf = "leaf";
-x3::rule<dataNode_class, dataNode_> const dataNode = "dataNode";
-x3::rule<schemaNode_class, schemaNode_> const schemaNode = "schemaNode";
-x3::rule<absoluteStart_class, Scope> const absoluteStart = "absoluteStart";
-x3::rule<schemaPath_class, schemaPath_> const schemaPath = "schemaPath";
-x3::rule<trailingSlash_class, TrailingSlash> const trailingSlash = "trailingSlash";
-x3::rule<dataNodeList_class, decltype(dataPath_::m_nodes)::value_type> const dataNodeList = "dataNodeList";
-x3::rule<dataNodesListEnd_class, decltype(dataPath_::m_nodes)> const dataNodesListEnd = "dataNodesListEnd";
-x3::rule<dataPathListEnd_class, dataPath_> const dataPathListEnd = "dataPathListEnd";
-x3::rule<dataPath_class, dataPath_> const dataPath = "dataPath";
-x3::rule<leaf_path_class, dataPath_> const leafPath = "leafPath";
-x3::rule<presenceContainerPath_class, dataPath_> const presenceContainerPath = "presenceContainerPath";
-x3::rule<listInstancePath_class, dataPath_> const listInstancePath = "listInstancePath";
-x3::rule<space_separator_class, x3::unused_type> const space_separator = "a space";
-
 x3::rule<discard_class, discard_> const discard = "discard";
 x3::rule<ls_class, ls_> const ls = "ls";
 x3::rule<cd_class, cd_> const cd = "cd";
@@ -51,13 +29,7 @@
 x3::rule<copy_class, copy_> const copy = "copy";
 x3::rule<command_class, command_> const command = "command";
 
-x3::rule<initializePath_class, x3::unused_type> const initializePath = "initializePath";
-x3::rule<createPathSuggestions_class, x3::unused_type> const createPathSuggestions = "createPathSuggestions";
-x3::rule<createKeySuggestions_class, x3::unused_type> const createKeySuggestions = "createKeySuggestions";
-x3::rule<createValueSuggestions_class, x3::unused_type> const createValueSuggestions = "createValueSuggestions";
-x3::rule<suggestKeysEnd_class, x3::unused_type> const suggestKeysEnd = "suggestKeysEnd";
 x3::rule<createCommandSuggestions_class, x3::unused_type> const createCommandSuggestions = "createCommandSuggestions";
-x3::rule<completing_class, x3::unused_type> const completing = "completing";
 
 #if __clang__
 #pragma GCC diagnostic push
@@ -66,110 +38,6 @@
 
 namespace ascii = boost::spirit::x3::ascii;
 
-using ascii::space;
-using x3::alnum;
-using x3::alpha;
-using x3::char_;
-using x3::expect;
-using x3::lexeme;
-using x3::lit;
-
-auto const key_identifier_def =
-    lexeme[
-        ((alpha | char_("_")) >> *(alnum | char_("_") | char_("-") | char_(".")))
-    ];
-
-auto const createKeySuggestions_def =
-    x3::eps;
-
-auto const createValueSuggestions_def =
-    x3::eps;
-
-auto const suggestKeysEnd_def =
-    x3::eps;
-
-auto const keyValue_def =
-    key_identifier > '=' > createValueSuggestions > leaf_data;
-
-auto const keyValueWrapper =
-    lexeme['[' > createKeySuggestions > keyValue > suggestKeysEnd > ']'];
-
-
-auto const listPrefix_def =
-    node_identifier;
-
-// even though we don't allow no keys to be supplied, the star allows me to check which keys are missing
-auto const listSuffix_def =
-    *keyValueWrapper;
-
-auto const listElement_def =
-    listPrefix >> &char_('[') > listSuffix;
-
-auto const list_def =
-    node_identifier >> !char_('[');
-
-auto const nodeup_def =
-    lit("..") > x3::attr(nodeup_());
-
-auto const container_def =
-    node_identifier;
-
-auto const leaf_def =
-    node_identifier;
-
-auto const createPathSuggestions_def =
-    x3::eps;
-
-// leaf cannot be in the middle of a path, however, I need the grammar's attribute to be a vector of variants
-auto const schemaNode_def =
-    createPathSuggestions >> -(module) >> (container | list | nodeup | leaf);
-
-auto const dataNode_def =
-    createPathSuggestions >> -(module) >> (container | listElement | nodeup | leaf);
-
-auto const absoluteStart_def =
-    x3::omit['/'] >> x3::attr(Scope::Absolute);
-
-auto const trailingSlash_def =
-    x3::omit['/'] >> x3::attr(TrailingSlash::Present);
-
-auto const space_separator_def =
-    x3::omit[x3::no_skip[space]];
-
-// This is a pseudo-parser, that fails if we're not completing a command
-auto const completing_def =
-    x3::no_skip[x3::eps];
-
-auto const rest =
-    x3::omit[x3::no_skip[+(char_ - '/' - space_separator)]];
-
-// I have to insert an empty vector to the first alternative, otherwise they won't have the same attribute
-auto const dataPath_def = initializePath >> absoluteStart >> createPathSuggestions >> x3::attr(decltype(dataPath_::m_nodes)()) >> x3::attr(TrailingSlash::NonPresent) >> x3::eoi | initializePath >> -(absoluteStart >> createPathSuggestions) >> dataNode % '/' >> (-(trailingSlash >> createPathSuggestions) >> -(completing >> rest) >> (&space_separator | x3::eoi));
-
-auto const dataNodeList_def =
-    createPathSuggestions >> -(module) >> list;
-
-// This intermediate rule is mandatory, because we need the first alternative
-// to be collapsed to a vector. If we didn't use the intermediate rule,
-// Spirit wouldn't know we want it to collapse.
-// https://github.com/boostorg/spirit/issues/408
-auto const dataNodesListEnd_def =
-    dataNode % '/' >> '/' >> dataNodeList >> -(&char_('/') >> createPathSuggestions) |
-    x3::attr(decltype(dataPath_::m_nodes)()) >> dataNodeList;
-
-auto const dataPathListEnd_def = initializePath >> absoluteStart >> createPathSuggestions >> x3::attr(decltype(dataPath_::m_nodes)()) >> x3::attr(TrailingSlash::NonPresent) >> x3::eoi | initializePath >> -(absoluteStart >> createPathSuggestions) >> dataNodesListEnd >> (-(trailingSlash >> createPathSuggestions) >> -(completing >> rest) >> (&space_separator | x3::eoi));
-
-auto const schemaPath_def = initializePath >> absoluteStart >> createPathSuggestions >> x3::attr(decltype(schemaPath_::m_nodes)()) >> x3::attr(TrailingSlash::NonPresent) >> x3::eoi | initializePath >> -(absoluteStart >> createPathSuggestions) >> schemaNode % '/' >> (-(trailingSlash >> createPathSuggestions) >> -(completing >> rest) >> (&space_separator | x3::eoi));
-
-auto const leafPath_def =
-    dataPath;
-
-auto const presenceContainerPath_def =
-    dataPath;
-
-auto const listInstancePath_def =
-    dataPath;
-
 struct ls_options_table : x3::symbols<LsOption> {
     ls_options_table()
     {
@@ -178,10 +46,6 @@
     }
 } const ls_options;
 
-// A "nothing" parser, which is used to indicate we tried to parse a path
-auto const initializePath_def =
-    x3::eps;
-
 auto const ls_def =
     ls_::name >> *(space_separator >> ls_options) >> -(space_separator >> ((dataPathListEnd | dataPath | schemaPath) | (module >> "*")));
 
@@ -280,29 +144,6 @@
 #pragma GCC diagnostic pop
 #endif
 
-BOOST_SPIRIT_DEFINE(keyValue)
-BOOST_SPIRIT_DEFINE(key_identifier)
-BOOST_SPIRIT_DEFINE(listPrefix)
-BOOST_SPIRIT_DEFINE(listSuffix)
-BOOST_SPIRIT_DEFINE(listElement)
-BOOST_SPIRIT_DEFINE(list)
-BOOST_SPIRIT_DEFINE(nodeup)
-BOOST_SPIRIT_DEFINE(schemaNode)
-BOOST_SPIRIT_DEFINE(dataNode)
-BOOST_SPIRIT_DEFINE(container)
-BOOST_SPIRIT_DEFINE(leaf)
-BOOST_SPIRIT_DEFINE(leafPath)
-BOOST_SPIRIT_DEFINE(presenceContainerPath)
-BOOST_SPIRIT_DEFINE(listInstancePath)
-BOOST_SPIRIT_DEFINE(space_separator)
-BOOST_SPIRIT_DEFINE(schemaPath)
-BOOST_SPIRIT_DEFINE(dataPath)
-BOOST_SPIRIT_DEFINE(dataNodeList)
-BOOST_SPIRIT_DEFINE(dataNodesListEnd)
-BOOST_SPIRIT_DEFINE(dataPathListEnd)
-BOOST_SPIRIT_DEFINE(absoluteStart)
-BOOST_SPIRIT_DEFINE(trailingSlash)
-BOOST_SPIRIT_DEFINE(initializePath)
 BOOST_SPIRIT_DEFINE(set)
 BOOST_SPIRIT_DEFINE(commit)
 BOOST_SPIRIT_DEFINE(get)
@@ -315,9 +156,4 @@
 BOOST_SPIRIT_DEFINE(help)
 BOOST_SPIRIT_DEFINE(copy)
 BOOST_SPIRIT_DEFINE(command)
-BOOST_SPIRIT_DEFINE(createPathSuggestions)
-BOOST_SPIRIT_DEFINE(createKeySuggestions)
-BOOST_SPIRIT_DEFINE(createValueSuggestions)
-BOOST_SPIRIT_DEFINE(suggestKeysEnd)
 BOOST_SPIRIT_DEFINE(createCommandSuggestions)
-BOOST_SPIRIT_DEFINE(completing)
diff --git a/src/parser.cpp b/src/parser.cpp
index 91b00a2..57511d3 100644
--- a/src/parser.cpp
+++ b/src/parser.cpp
@@ -39,7 +39,7 @@
             x3::with<parser_context_tag>(ctx)[
             x3::with<x3::error_handler_tag>(std::ref(errorHandler))[command]
     ];
-    bool result = x3::phrase_parse(it, line.end(), grammar, space, parsedCommand);
+    bool result = x3::phrase_parse(it, line.end(), grammar, x3::space, parsedCommand);
 
     if (!result || it != line.end()) {
         throw InvalidCommandException(std::string(it, line.end()) + " this was left of input");
@@ -61,7 +61,7 @@
             x3::with<parser_context_tag>(ctx)[
             x3::with<x3::error_handler_tag>(std::ref(errorHandler))[command]
     ];
-    x3::phrase_parse(it, line.end(), grammar, space, parsedCommand);
+    x3::phrase_parse(it, line.end(), grammar, x3::space, parsedCommand);
 
     auto completionIterator = ctx.m_completionIterator ? *ctx.m_completionIterator : line.end();
 
diff --git a/src/path_parser.hpp b/src/path_parser.hpp
new file mode 100644
index 0000000..af98208
--- /dev/null
+++ b/src/path_parser.hpp
@@ -0,0 +1,173 @@
+/*
+ * Copyright (C) 2020 CESNET, https://photonics.cesnet.cz/
+ *
+ * Written by Václav Kubernát <kubernat@cesnet.cz>
+ *
+*/
+
+#pragma once
+
+#include <boost/spirit/home/x3.hpp>
+#include "ast_handlers.hpp"
+#include "common_parsers.hpp"
+#include "leaf_data.hpp"
+
+namespace x3 = boost::spirit::x3;
+
+x3::rule<dataPath_class, dataPath_> const dataPath = "dataPath";
+x3::rule<schemaPath_class, schemaPath_> const schemaPath = "schemaPath";
+x3::rule<dataNodeList_class, decltype(dataPath_::m_nodes)::value_type> const dataNodeList = "dataNodeList";
+x3::rule<dataNodesListEnd_class, decltype(dataPath_::m_nodes)> const dataNodesListEnd = "dataNodesListEnd";
+x3::rule<dataPathListEnd_class, dataPath_> const dataPathListEnd = "dataPathListEnd";
+x3::rule<leaf_path_class, dataPath_> const leafPath = "leafPath";
+x3::rule<presenceContainerPath_class, dataPath_> const presenceContainerPath = "presenceContainerPath";
+x3::rule<listInstancePath_class, dataPath_> const listInstancePath = "listInstancePath";
+x3::rule<initializePath_class, x3::unused_type> const initializePath = "initializePath";
+x3::rule<createPathSuggestions_class, x3::unused_type> const createPathSuggestions = "createPathSuggestions";
+x3::rule<trailingSlash_class, TrailingSlash> const trailingSlash = "trailingSlash";
+x3::rule<dataNode_class, dataNode_> const dataNode = "dataNode";
+x3::rule<schemaNode_class, schemaNode_> const schemaNode = "schemaNode";
+x3::rule<absoluteStart_class, Scope> const absoluteStart = "absoluteStart";
+x3::rule<keyValue_class, keyValue_> const keyValue = "keyValue";
+x3::rule<key_identifier_class, std::string> const key_identifier = "key_identifier";
+x3::rule<listPrefix_class, std::string> const listPrefix = "listPrefix";
+x3::rule<listSuffix_class, std::vector<keyValue_>> const listSuffix = "listSuffix";
+x3::rule<listElement_class, listElement_> const listElement = "listElement";
+x3::rule<list_class, list_> const list = "list";
+x3::rule<nodeup_class, nodeup_> const nodeup = "nodeup";
+x3::rule<container_class, container_> const container = "container";
+x3::rule<leaf_class, leaf_> const leaf = "leaf";
+x3::rule<createKeySuggestions_class, x3::unused_type> const createKeySuggestions = "createKeySuggestions";
+x3::rule<createValueSuggestions_class, x3::unused_type> const createValueSuggestions = "createValueSuggestions";
+x3::rule<suggestKeysEnd_class, x3::unused_type> const suggestKeysEnd = "suggestKeysEnd";
+
+
+#if __clang__
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Woverloaded-shift-op-parentheses"
+#endif
+
+auto const rest =
+    x3::omit[x3::no_skip[+(x3::char_ - '/' - space_separator)]];
+
+auto const key_identifier_def =
+    x3::lexeme[
+        ((x3::alpha | char_("_")) >> *(x3::alnum | char_("_") | char_("-") | char_(".")))
+    ];
+
+auto const createKeySuggestions_def =
+    x3::eps;
+
+auto const createValueSuggestions_def =
+    x3::eps;
+
+auto const suggestKeysEnd_def =
+    x3::eps;
+
+auto const keyValue_def =
+    key_identifier > '=' > createValueSuggestions > leaf_data;
+
+auto const keyValueWrapper =
+    x3::lexeme['[' > createKeySuggestions > keyValue > suggestKeysEnd > ']'];
+
+auto const listPrefix_def =
+    node_identifier;
+
+// even though we don't allow no keys to be supplied, the star allows me to check which keys are missing
+auto const listSuffix_def =
+    *keyValueWrapper;
+
+auto const listElement_def =
+    listPrefix >> &char_('[') > listSuffix;
+
+auto const list_def =
+    node_identifier >> !char_('[');
+
+auto const nodeup_def =
+    x3::lit("..") > x3::attr(nodeup_());
+
+auto const container_def =
+    node_identifier;
+
+auto const leaf_def =
+    node_identifier;
+
+auto const absoluteStart_def =
+    x3::omit['/'] >> x3::attr(Scope::Absolute);
+
+auto const trailingSlash_def =
+    x3::omit['/'] >> x3::attr(TrailingSlash::Present);
+
+auto const createPathSuggestions_def =
+    x3::eps;
+
+// leaf cannot be in the middle of a path, however, I need the grammar's attribute to be a vector of variants
+auto const schemaNode_def =
+    createPathSuggestions >> -(module) >> (container | list | nodeup | leaf);
+
+auto const dataNode_def =
+    createPathSuggestions >> -(module) >> (container | listElement | nodeup | leaf);
+
+// I have to insert an empty vector to the first alternative, otherwise they won't have the same attribute
+auto const dataPath_def = initializePath >> absoluteStart >> createPathSuggestions >> x3::attr(decltype(dataPath_::m_nodes)()) >> x3::attr(TrailingSlash::NonPresent) >> x3::eoi | initializePath >> -(absoluteStart >> createPathSuggestions) >> dataNode % '/' >> (-(trailingSlash >> createPathSuggestions) >> -(completing >> rest) >> (&space_separator | x3::eoi));
+
+auto const dataNodeList_def =
+    createPathSuggestions >> -(module) >> list;
+
+// This intermediate rule is mandatory, because we need the first alternative
+// to be collapsed to a vector. If we didn't use the intermediate rule,
+// Spirit wouldn't know we want it to collapse.
+// https://github.com/boostorg/spirit/issues/408
+auto const dataNodesListEnd_def =
+    dataNode % '/' >> '/' >> dataNodeList >> -(&char_('/') >> createPathSuggestions) |
+    x3::attr(decltype(dataPath_::m_nodes)()) >> dataNodeList;
+
+auto const dataPathListEnd_def = initializePath >> absoluteStart >> createPathSuggestions >> x3::attr(decltype(dataPath_::m_nodes)()) >> x3::attr(TrailingSlash::NonPresent) >> x3::eoi | initializePath >> -(absoluteStart >> createPathSuggestions) >> dataNodesListEnd >> (-(trailingSlash >> createPathSuggestions) >> -(completing >> rest) >> (&space_separator | x3::eoi));
+
+auto const schemaPath_def = initializePath >> absoluteStart >> createPathSuggestions >> x3::attr(decltype(schemaPath_::m_nodes)()) >> x3::attr(TrailingSlash::NonPresent) >> x3::eoi | initializePath >> -(absoluteStart >> createPathSuggestions) >> schemaNode % '/' >> (-(trailingSlash >> createPathSuggestions) >> -(completing >> rest) >> (&space_separator | x3::eoi));
+
+auto const leafPath_def =
+    dataPath;
+
+auto const presenceContainerPath_def =
+    dataPath;
+
+auto const listInstancePath_def =
+    dataPath;
+
+// A "nothing" parser, which is used to indicate we tried to parse a path
+auto const initializePath_def =
+    x3::eps;
+
+
+
+#if __clang__
+#pragma GCC diagnostic pop
+#endif
+
+BOOST_SPIRIT_DEFINE(keyValue)
+BOOST_SPIRIT_DEFINE(key_identifier)
+BOOST_SPIRIT_DEFINE(listPrefix)
+BOOST_SPIRIT_DEFINE(listSuffix)
+BOOST_SPIRIT_DEFINE(listElement)
+BOOST_SPIRIT_DEFINE(list)
+BOOST_SPIRIT_DEFINE(nodeup)
+BOOST_SPIRIT_DEFINE(schemaNode)
+BOOST_SPIRIT_DEFINE(dataNode)
+BOOST_SPIRIT_DEFINE(container)
+BOOST_SPIRIT_DEFINE(leaf)
+BOOST_SPIRIT_DEFINE(dataNodeList)
+BOOST_SPIRIT_DEFINE(dataNodesListEnd)
+BOOST_SPIRIT_DEFINE(leafPath)
+BOOST_SPIRIT_DEFINE(presenceContainerPath)
+BOOST_SPIRIT_DEFINE(listInstancePath)
+BOOST_SPIRIT_DEFINE(schemaPath)
+BOOST_SPIRIT_DEFINE(dataPath)
+BOOST_SPIRIT_DEFINE(dataPathListEnd)
+BOOST_SPIRIT_DEFINE(initializePath)
+BOOST_SPIRIT_DEFINE(createKeySuggestions)
+BOOST_SPIRIT_DEFINE(createPathSuggestions)
+BOOST_SPIRIT_DEFINE(createValueSuggestions)
+BOOST_SPIRIT_DEFINE(suggestKeysEnd)
+BOOST_SPIRIT_DEFINE(absoluteStart)
+BOOST_SPIRIT_DEFINE(trailingSlash)