Auto completion does not work for strings including space. Seen only when autocompletion is strict and is via customary callback in .cli file

[DeekshaBhandary]

Case 1:

supervisor@apr29: cfg> show bgp peer instance    
  "i1 space"            Peer information for an instance                                                                                      
  i1                    Peer information for an instance                                                                                      
supervisor@apr29: cfg> show bgp peer instance i1 
  <cr>
  detail                Detailed peer information                                                                                             
supervisor@apr29: cfg> show bgp peer instance "i1 space" <PRESS ?>   <----expand options not seen
supervisor@apr29: cfg> show bgp peer instance "i1 space" 
CLI syntax error: "show bgp peer instance "i1 space"": Unknown command          
supervisor@apr29: cfg> set instance            
  "i1 space"            An operator-assigned unique name for the network instance                                                             
  i1                    An operator-assigned unique name for the network instance                                                             
  <name>                An operator-assigned unique name for the network instance                                                             
supervisor@apr29: cfg> 

Case 2:

supervisor@apr29: cfg>set instance i1 
  <cr>
  address-family        Instance address family related configurations                                                                        
  ipv4-router-id        IPv4 router id of the routing instance                                                                                
  protocol              Protocol configuration                                                                                                
  route-distinguisher   VPN Route Distinguisher. Format: {as_number | ipv4_address}:rd_identifier                                             
  static                Configuration data for static route configuration table                                                               
  tcp                   TCP configuration                                                                                                     
supervisor@apr29: cfg> set instance "i1 space"             <----works for the CLI tree
  <cr>
  address-family        Instance address family related configurations                                                                        
  ipv4-router-id        IPv4 router id of the routing instance                                                                                
  protocol              Protocol configuration                                                                                                
  route-distinguisher   VPN Route Distinguisher. Format: {as_number | ipv4_address}:rd_identifier                                             
  static                Configuration data for static route configuration table                                                               
  tcp                   TCP configuration                                                                                                     
supervisor@apr29: cfg> set instance "i1 space" 

As far as my analysis i found the issue in cligen_str2cvv . In the tokens that are generated quotes are not included. Adding them using escape character solves the issue. i have done the code changes and tested it.
The reason it works in the case 2 is because for strings with space, in match_vec it gets matched against the generic node
and not the specified value

can you please confirm this?

[olofhagsand]

I need some more info on the show command:
supervisor@apr29: cfg> show bgp peer instance "i1 space" <PRESS ?> <----expand options not seen
which cli callback is this: cli_auto_show() or cli_show_auto(), can you please provide the cligen line of that command?

[DeekshaBhandary]

The show command syntax is derived from .cli file:
file bgp.cli :

show("Show a particular state of the system") {
    bgp("BGP protocol information") {
                peer("Peer information"), rtb_cli_exec("bgp", "show_bgp_peer"); {
                (<peer_name:string expand_func("bgp","bgp_peer_host_expander")>("Peer name")), exec_func("bgp", "show_bgp_peer_host"); {
                detail("Detailed peer information"), exec_func("bgp", "show_bgp_peer_detail"); 
			}
		}
	}
}

expand_func and exec_func are C functions that call other functions to achieve expansion and to display the output (specified as 2nd argument. the functions called by expand_func and exec_func are written in python).

container bgp {
     ..
	 ..
     uses bgp-peer;	 
}
	 
grouping bgp-peer {
	    list interface {
		    key "name";
			leaf name {
			}
			uses bgp-pg-name;
	}
}
			
grouping bgp-pg-name {
        description "BGP peer group name";
        leaf peer-group {
            type string;
		}
}

[olofhagsand]

I cannot re-create it in my example code.
It may very well be errors in the clixon code, but in the efforts I made to recreate it I failed.
It may also be some problem in your code.
Working example using clixon main example:

olof@alarik /> set interfaces interface "a b" type ex:eth
olof@alarik /> show auto interfaces interface <PRESS ?> <---------
  "a b"                 The name of the interface.                                                   
  <name>                The name of the interface.                                                   
olof@alarik /> show auto interfaces interface "a<PRESS TAB>  <----
olof@alarik /> show auto interfaces interface "a b"
 xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces"<interface>
   <name>a b</name>
   <type>ex:eth</type>
   <enabled>true</enabled>
</interface>
olof@alarik /> 

Can you recreate the problem using the main example?

[olofhagsand]

This may do it?

diff --git a/cligen_match.c b/cligen_match.c
index 2ec6aeb..241e808 100644
--- a/cligen_match.c
+++ b/cligen_match.c
@@ -158,7 +158,10 @@ match_object(cligen_handle h,
       if (str == NULL)
          match++;
       else{
-         match = (strncmp(co->co_command, str, len) == 0);
+         if (*co->co_command == '\"') /* escaped */
+             match = (strncmp(co->co_command+1, str, len) == 0);
+         else
+             match = (strncmp(co->co_command, str, len) == 0);
          if (exact)
              *exact = strlen(co->co_command) == len;
          if (match == 0 && reason){

[olofhagsand]

Should work now. Please verify