Always have full path in path field and formatting

Author: seanhinde

src/ecli.erl

@@ -8,7 +8,6 @@
 %%%-------------------------------------------------------------------
 -module(ecli).
 
--include("ecli_internal.hrl").
 -include("../include/ecli.hrl").
 
 %% API
@@ -161,17 +160,17 @@ format_table([#{} | _] = Maps, TitlesInOrder) ->
     TitleLengths = lists:map(fun(T) -> {T, key_size(T)} end, TitlesInOrder),
     Lengths = maps:from_list(TitleLengths),
     ColLengths = lists:foldl(
-                    fun(M, Ls) ->
-                        maps:fold(fun(K, V, L) ->
-                            maps:put(K, max(maps:get(K, L), printable_size(V)), L)
-                        end, Ls, M)
-                    end, Lengths, Maps),
+                   fun(M, Ls) ->
+                           maps:fold(fun(K, V, L) ->
+                                             maps:put(K, max(maps:get(K, L), printable_size(V)), L)
+                                     end, Ls, M)
+                   end, Lengths, Maps),
     OrderedColLengths = lists:map(fun(T) -> {T, maps:get(T, ColLengths)} end, TitlesInOrder),
     TitleRow = pad_row(OrderedColLengths),
     TitleUnderline = pad_row(lists:map(fun({T, L}) -> {list_to_binary(lists:duplicate(printable_size(T), $-)), L} end, OrderedColLengths)),
     Rows = lists:map(fun(Row) ->
-                        RowWithLengths = lists:map(fun(T) -> {maps:get(T, Row), maps:get(T, ColLengths)} end, TitlesInOrder),
-                        [pad_row(RowWithLengths), "\r\n"]
+                             RowWithLengths = lists:map(fun(T) -> {maps:get(T, Row), maps:get(T, ColLengths)} end, TitlesInOrder),
+                             [pad_row(RowWithLengths), "\r\n"]
                      end, Maps),
     [TitleRow, "\r\n", TitleUnderline, "\r\n", Rows].
 
@@ -200,4 +199,4 @@ pad_row([{Val, Len} | Vals]) ->
     [pad(Printable, Len + 1) | pad_row(Vals)].
 
 spaces(Num) ->
-    lists:duplicate(Num, $\s).
+    lists:duplicate(Num, $\s).

src/ecli_edlin.erl

@@ -12,11 +12,11 @@
 
 -record(edlin,
         {
-          line = {[], []},       % {Chars_before_cursor, Chars_after}
-          state = none,
-          prompt,
-          requests = [],
-          history = {[],[]}      % {Before, After}
+         line = {[], []},       % {Chars_before_cursor, Chars_after}
+         state = none,
+         prompt,
+         requests = [],
+         history = {[],[]}      % {Before, After}
         }).
 
 %%--------------------------------------------------------------------
@@ -101,7 +101,7 @@ insert([C|Cs], #edlin{state = State, line = {Bef, Aft},
             case do_op(Op, Bef, Aft, Rs0) of
                 {Line, Rs, Mode} -> % allow custom modes from do_op
                     insert(Cs, Ed#edlin{line = Line, state = Mode,
-                                           requests = Rs});
+                                        requests = Rs});
                 {Line, Rs} ->
                     insert(Cs, Ed#edlin{line = Line, state = none, requests = Rs})
             end

src/ecli_expand.erl

@@ -76,7 +76,7 @@ parse([{token, Tok} | Ts], Tree, [#{node_type := NodeType} | _] = Acc, Txn, Cmd)
         {ok, #{node_type := container} = Item} ->
             NewCmd = maps:get(cmd_type, Item, Cmd),
             Children = menu_item_children(Item, Txn, NewCmd),
-            ?DBG("Adding Container Item in container = ~p~n", [Item]),
+            ?DBG("Adding Container Item in container = ~p children ~p~n", [Item, Children]),
             parse(Ts, Children, [Item | Acc], Txn, NewCmd);
         {ok, #{node_type := Leaf, type := Type} = Item} when Leaf == leaf; Leaf == leaf_list ->
             %% Expecting a leaf value, possibly followed by more entries in the same
@@ -211,7 +211,7 @@ parse_list_keys([{token, Tok} | Ts], #{key_names := KeyNames, key_values := KeyV
             %% Got the list keys, carry on in the main parser
             Children = menu_item_children(Item1, Txn, Cmd),
             parse(Ts, Children, [Item1 | Acc], Txn, Cmd);
-        true ->
+       true ->
             parse_list_keys(Ts, Item1, Acc, Txn, Cmd)
     end.
 
@@ -251,7 +251,7 @@ expand_after_space([], [#{node_type := leaf, value := _Val} | _Acc], _Txn, _Cmd)
     %% This leaf has a value, but no peer items. End of the command
     no;
 expand_after_space(Tree, [#{node_type := leaf, value := _Val} | _Acc], _Txn, _Cmd) ->
-     %% This leaf has a value. Show the remaining Menu items
+    %% This leaf has a value. Show the remaining Menu items
     Menu = ecli:format_menu(Tree),
     {yes, "", Menu};
 expand_after_space(_Menu, [#{node_type := leaf, desc := Desc, type := Type} | _Acc], _Txn, _Cmd) ->
@@ -332,7 +332,7 @@ remove(Tok, Tree) ->
 %% each key in sequence. Once we have all list keys children become
 %% the items inside the list item, minus the list key names.
 menu_item_children(Item, Txn, CmdType) ->
-     ecli_util:children(Item, Txn, CmdType).
+    ecli_util:children(Item, Txn, CmdType).
 
 %% Find characters to add to fill up to where the node names diverge
 %% e.g. names configure and contain given an input of "c" should return "on"
@@ -342,7 +342,7 @@ expand_menus(Str, Menus) ->
     Suffixes = lists:map(fun(#{name := Name}) ->
                                  lists:nthtail(StrLen, Name);
                             (#cmd{name = Name}) ->
-                                lists:nthtail(StrLen, Name)
+                                 lists:nthtail(StrLen, Name)
                          end, Menus),
     %% ?DBG("expand_menus ML = ~p~n",[Suffixes]),
     longest_common_prefix(Suffixes).

src/ecli_history.erl

@@ -2,19 +2,19 @@
 %%% @author Sean Hinde <sean@Seans-MacBook.local>
 %%% @copyright (C) 2022, Sean Hinde
 %%% @doc Implementation of cli history
-%%% 
+%%%
 %%% Expected Behaviour
 %%% ==================
-%%% 
-%%% Initially prev/1 should give us the previous line, prev/1 again the line 
+%%%
+%%% Initially prev/1 should give us the previous line, prev/1 again the line
 %%% previous to that. Then next/1 should give us the first prev line and next/1
 %%% back to whatever the user had on the line before exploring the history.
-%%% 
-%%% If any line in the history is edited it should still appear edited after 
+%%%
+%%% If any line in the history is edited it should still appear edited after
 %%% moving away and back, but only until a command is executed. At that point
 %%% all the original history should be restored with the executed command as
 %%% the most recent
-%%% 
+%%%
 %%% So during a single history session we don't need to care about the original
 %%% state. We can just track edited lines in the history. Immutability is a
 %%% superpower :)

src/ecli_lookup.erl

@@ -187,7 +187,7 @@ parse_list_keys([{token, Tok} | Ts], #{key_names := KeyNames, key_values := KeyV
             %% Got the list keys, carry on in the main parser
             Children = ecli_util:children(Item1, Txn, undefined),
             parse(Ts, Children, [Item1 | Acc], Txn);
-        true ->
+       true ->
             parse_list_keys(Ts, Item1, Acc, Txn)
     end.
 
@@ -246,4 +246,4 @@ lookup(_, []) ->
     false.
 
 remove(Tok, Tree) ->
-    lists:filter(fun(#{name := Name}) -> Name /= Tok end, Tree).
+    lists:filter(fun(#{name := Name}) -> Name /= Tok end, Tree).

src/ecli_server.erl

@@ -20,17 +20,17 @@
 
 -record(state,
         {
-          socket,
-          listen_pid,
-          listen_socket,
-          term,                                 % #ecli_term{}
-          edlin,                                % #ecli_edlin{}
-          ecli_mod,         % User defined CLI callback implementation
-          ecli_state,          % State threaded through cli callbacks
-          history = [],     % command line history for this session
-          got_meta = false,
-          buf = <<>>                     % Temp buf for UTF boundaries
-         }).
+         socket,
+         listen_pid,
+         listen_socket,
+         term,                                 % #ecli_term{}
+         edlin,                                % #ecli_edlin{}
+         ecli_mod,         % User defined CLI callback implementation
+         ecli_state,          % State threaded through cli callbacks
+         history = [],     % command line history for this session
+         got_meta = false,
+         buf = <<>>                     % Temp buf for UTF boundaries
+        }).
 
 %%%===================================================================
 %%% API
@@ -220,7 +220,7 @@ process_sigwinch(Bin, Term) ->
                     {SigWinch, Trailing} = erlang:split_binary(SigWinchPre, 12),
                     {Rows, Cols} = parse_sigwinch(SigWinch),
                     process_sigwinch(<<PreData/binary, Trailing/binary>>, ecli_term:sigwinch(Rows, Cols, Term));
-                true ->
+               true ->
                     %% Partial Sigwinch update
                     {PreData, PartSigWinch} = erlang:split_binary(Bin, Start),
                     {PreData, Term, PartSigWinch}
@@ -267,15 +267,15 @@ get_chars_loop(CharList, #state{ecli_mod = CliMod} = State) ->
                     Term = send_drv(Ops, State#state.socket, State#state.term),
                     {ok, Prompt} = CliMod:prompt(CliState),
                     History = case FullLine of
-                                "" -> State#state.history;
-                                _-> [FullLine | State#state.history]
+                                  "" -> State#state.history;
+                                  _-> [FullLine | State#state.history]
                               end,
                     {Edlin, InitialOps} = ecli_edlin:start(Prompt, History),
                     Term1 = send_drv(InitialOps, State#state.socket, Term),
                     get_chars_loop(Cs, State#state{term = Term1,
-                                                edlin = Edlin,
-                                                history = History,
-                                                ecli_state = CliState});
+                                                   edlin = Edlin,
+                                                   history = History,
+                                                   ecli_state = CliState});
                 stop ->
                     gen_tcp:close(State#state.socket),
                     stop
@@ -293,7 +293,7 @@ get_chars_loop(CharList, #state{ecli_mod = CliMod} = State) ->
                 stop ->
                     stop;
                 CliState2 ->
-                    ok = send_raw("\r\n", State),
+                    ok = send_raw("\r\n\r\n[ok]\r\n", State),
                     {ok, Prompt} = CliMod:prompt(CliState2),
                     {Edlin, InitialOps} = ecli_edlin:start(Prompt, State#state.history),
                     Term1 = send_drv(InitialOps, State#state.socket, State#state.term),

src/ecli_tokenise.erl

@@ -2,7 +2,7 @@
 %%% @author Sean Hinde <sean@Seans-MacBook.local>
 %%% @copyright (C) 2022, Sean Hinde
 %%% @doc CLI Command string tokeniser useful for completion and execution
-%%% 
+%%%
 %%% Created : 30 Apr 2022 by Sean Hinde <sean@Seans-MacBook.local>
 %%%-------------------------------------------------------------------
 -module(ecli_tokenise).
@@ -32,4 +32,4 @@ tokenise_string([$\" | Cs], Str, Acc) ->
 tokenise_string([C|Cs], Str, Acc) ->
     tokenise_string(Cs, [C|Str], Acc);
 tokenise_string([], Str, Acc) ->
-    {ok, lists:reverse([{part_string, lists:reverse(Str)} | Acc])}.
+    {ok, lists:reverse([{part_string, lists:reverse(Str)} | Acc])}.

src/ecli_types.erl

@@ -29,19 +29,19 @@
 %% xpath1.0
 
 -type yang_type() :: counter32
-                    | 'zero-based-counter32'
-                    | counter64
-                    | 'zero-based-counter64'
-                    | gauge32
-                    | gauge64
-                    | 'object-identifier'
-                    | 'object-identifier-128'
-                    | 'date-and-time'
-                    | timeticks
-                    | timestamp
-                    | 'phys-address'
-                    | 'mac-address'
-                    | 'xpath1.0'.
+                   | 'zero-based-counter32'
+                   | counter64
+                   | 'zero-based-counter64'
+                   | gauge32
+                   | gauge64
+                   | 'object-identifier'
+                   | 'object-identifier-128'
+                   | 'date-and-time'
+                   | timeticks
+                   | timestamp
+                   | 'phys-address'
+                   | 'mac-address'
+                   | 'xpath1.0'.
 
 -spec parse(yang_type(), string()) -> {ok, any()} | {error, string()}.
 parse(counter32, Value) ->
@@ -70,4 +70,4 @@ parse(counter32, Value) ->
 %% ipv6-prefix
 %% domain-name
 %% host
-%% uri
+%% uri

src/ecli_unixdom_listen.erl

@@ -20,10 +20,10 @@
 
 -record(state,
         {
-          listen_socket,
-          path,
-          ecli_mod,
-          acceptor_pid
+         listen_socket,
+         path,
+         ecli_mod,
+         acceptor_pid
         }).
 
 %%%===================================================================