summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Estabrook <jestabro@vyos.io>2023-05-01 11:05:47 -0500
committerJohn Estabrook <jestabro@vyos.io>2023-05-10 22:52:25 -0500
commitabc03517fe7784de951d930ba76f1bd7db5fe63b (patch)
tree5ff2830c5c066927d98c161c83d52fcbaa335619
parent68c84be87fd38c9f38ddd5ddf0a88cf4c5ff7ecb (diff)
downloadvyos1x-config-abc03517fe7784de951d930ba76f1bd7db5fe63b.tar.gz
vyos1x-config-abc03517fe7784de951d930ba76f1bd7db5fe63b.zip
T5194: add completion_help
-rw-r--r--src/reference_tree.ml34
-rw-r--r--src/reference_tree.mli9
2 files changed, 40 insertions, 3 deletions
diff --git a/src/reference_tree.ml b/src/reference_tree.ml
index e6738aa..c9ce5a3 100644
--- a/src/reference_tree.ml
+++ b/src/reference_tree.ml
@@ -9,12 +9,19 @@ type value_constraint =
| External of string * string option [@name "exec"]
[@@deriving yojson]
+type completion_help_type =
+ | List of string [@name "list"]
+ | Path of string [@name "path"]
+ | Script of string [@name "script"]
+ [@@deriving yojson]
+
type ref_node_data = {
node_type: node_type;
constraints: value_constraint list;
+ constraint_error_message: string;
+ completion_help: completion_help_type list;
help: string;
value_help: (string * string) list;
- constraint_error_message: string;
multi: bool;
valueless: bool;
owner: string option;
@@ -33,9 +40,10 @@ exception Validation_error of string
let default_data = {
node_type = Other;
constraints = [];
+ constraint_error_message = "Invalid value";
+ completion_help = [];
help = "No help available";
value_help = [];
- constraint_error_message = "Invalid value";
multi = false;
valueless = false;
owner = None;
@@ -57,6 +65,14 @@ let node_type_of_string s =
| _ -> raise (Bad_interface_definition
(Printf.sprintf "node, tagNode, or leafNode expected, %s found" s))
+let completion_help_type_of_string v s =
+ match v with
+ | "list" -> List s
+ | "path" -> Path s
+ | "script" -> Script s
+ | _ -> raise (Bad_interface_definition
+ (Printf.sprintf "list, path, or script expected, %s found" s))
+
(** Find a child node in xml-lite *)
let find_xml_child name xml =
let find_aux e =
@@ -90,6 +106,18 @@ let load_value_help_from_xml d x =
let vhs' = (fmt, descr) :: vhs in
{d with value_help=vhs'}
+let load_completion_help_from_xml d c =
+ let res =
+ let aux l c =
+ match c with
+ | Xml.Element (_, _, [Xml.PCData s]) ->
+ l @ [completion_help_type_of_string (Xml.tag c) s]
+ | _ -> raise (Bad_interface_definition "Malformed completion help")
+ in Xml.fold aux [] c in
+ let l = d.completion_help in
+ let l' = l @ res in
+ {d with completion_help=l'}
+
let load_constraint_from_xml d c =
let aux d c =
match c with
@@ -110,6 +138,8 @@ let data_from_xml d x =
match x with
| Xml.Element ("help", _, [Xml.PCData s]) -> {d with help=s}
| Xml.Element ("valueHelp", _, _) -> load_value_help_from_xml d x
+ | Xml.Element ("completionHelp", _, _) ->
+ load_completion_help_from_xml d x
| Xml.Element ("multi", _, _) -> {d with multi=true}
| Xml.Element ("valueless", _, _) -> {d with valueless=true}
| Xml.Element ("constraintErrorMessage", _, [Xml.PCData s]) ->
diff --git a/src/reference_tree.mli b/src/reference_tree.mli
index baa2694..6d02093 100644
--- a/src/reference_tree.mli
+++ b/src/reference_tree.mli
@@ -9,12 +9,19 @@ type value_constraint =
| External of string * string option [@name "exec"]
[@@deriving yojson]
+type completion_help_type =
+ | List of string [@name "list"]
+ | Path of string [@name "path"]
+ | Script of string [@name "script"]
+ [@@deriving yojson]
+
type ref_node_data = {
node_type: node_type;
constraints: value_constraint list;
+ constraint_error_message: string;
+ completion_help: completion_help_type list;
help: string;
value_help: (string * string) list;
- constraint_error_message: string;
multi: bool;
valueless: bool;
owner: string option;