clish.xsd 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480
  1. <?xml version="1.0"?>
  2. <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://clish.sourceforge.net/XMLSchema" targetNamespace="http://clish.sourceforge.net/XMLSchema">
  3. <!--
  4. ***********************************************************
  5. * Forward declare the main element identifiers
  6. ***********************************************************
  7. -->
  8. <xs:element name="CLISH_MODULE" type="clish_module_t"/>
  9. <xs:element name="VIEW" type="view_t"/>
  10. <xs:element name="COMMAND" type="command_t"/>
  11. <xs:element name="STARTUP" type="startup_t"/>
  12. <xs:element name="ACTION" type="action_t"/>
  13. <xs:element name="OVERVIEW" type="overview_t"/>
  14. <xs:element name="DETAIL" type="detail_t"/>
  15. <xs:element name="PTYPE" type="ptype_t"/>
  16. <xs:element name="PARAM" type="param_t"/>
  17. <xs:element name="NAMESPACE" type="namespace_t"/>
  18. <xs:element name="CONFIG" type="config_t"/>
  19. <xs:element name="VAR" type="var_t"/>
  20. <xs:element name="WATCHDOG" type="wdog_t"/>
  21. <!--
  22. ***********************************************************
  23. * The common simple types
  24. ***********************************************************
  25. -->
  26. <xs:simpleType name="bool_t">
  27. <xs:restriction base="xs:string">
  28. <xs:enumeration value="true"/>
  29. <xs:enumeration value="false"/>
  30. </xs:restriction>
  31. </xs:simpleType>
  32. <!--
  33. ***********************************************************
  34. * <CLISH_MODULE> is the top level container.
  35. * Any commands which are defined within this tag are global in scope
  36. * i.e. they are visible from all views.
  37. ***********************************************************
  38. -->
  39. <xs:complexType name="clish_module_t">
  40. <xs:sequence>
  41. <xs:element ref="OVERVIEW" minOccurs="0"/>
  42. <xs:element ref="STARTUP" minOccurs="0"/>
  43. <xs:element ref="PTYPE" minOccurs="0" maxOccurs="unbounded"/>
  44. <xs:element ref="COMMAND" minOccurs="0" maxOccurs="unbounded"/>
  45. <xs:element ref="VIEW" minOccurs="0" maxOccurs="unbounded"/>
  46. <xs:element ref="NAMESPACE" minOccurs="0" maxOccurs="unbounded"/>
  47. <xs:element ref="VAR" minOccurs="0" maxOccurs="unbounded"/>
  48. </xs:sequence>
  49. </xs:complexType>
  50. <!--
  51. ***********************************************************
  52. * Identify some attribute groups
  53. ***********************************************************
  54. -->
  55. <xs:attributeGroup name="menu_item_g">
  56. <xs:attribute name="name" type="xs:string" use="required"/>
  57. <xs:attribute name="help" type="xs:string" use="required"/>
  58. </xs:attributeGroup>
  59. <!--
  60. *******************************************************
  61. * <PTYPE> is used to define the syntax for a parameter type.
  62. *
  63. * name - a textual name for this type. This name can be used to
  64. * reference this type within a <PARAM? ptype attribute.
  65. *
  66. * help - a textual string which describes the syntax of this type.
  67. * When a parameter is filled out incorrectly on the CLI, this
  68. * text will be used to prompt the user to fill out the value
  69. * correctly.
  70. *
  71. * pattern - A regular expression which defines the syntax of the type.
  72. *
  73. * method - The means by which the pattern is interpreted.
  74. *
  75. * "regexp" [default] - A POSIX regular expression.
  76. *
  77. * "integer" - A numeric definition "min..max"
  78. *
  79. * "select" - A list of possible values.
  80. * The syntax of the string is of the form:
  81. * "valueOne(ONE) valueTwo(TWO) valueThree(THREE)"
  82. * where the text before the parethesis defines the syntax
  83. * that the user must use, and the value within the parenthesis
  84. * is the result expanded as a parameter value.
  85. *
  86. * preprocess - An optional directive to process the value entered before
  87. * validating it. This can greatly simplify the regular expressions
  88. * needed to match case insensitive values.
  89. *
  90. * "none" [default] - do nothing
  91. *
  92. * "toupper" - before validation convert to uppercase.
  93. *
  94. * "tolower" - before validation convert to lowercase.
  95. *
  96. ********************************************************
  97. -->
  98. <xs:simpleType name="ptype_method_e">
  99. <xs:restriction base="xs:string">
  100. <xs:enumeration value="regexp"/>
  101. <xs:enumeration value="integer"/>
  102. <xs:enumeration value="select"/>
  103. <xs:enumeration value="choice"/>
  104. <xs:enumeration value="subcommand"/>
  105. </xs:restriction>
  106. </xs:simpleType>
  107. <xs:simpleType name="ptype_preprocess_e">
  108. <xs:restriction base="xs:string">
  109. <xs:enumeration value="none"/>
  110. <xs:enumeration value="toupper"/>
  111. <xs:enumeration value="tolower"/>
  112. </xs:restriction>
  113. </xs:simpleType>
  114. <xs:complexType name="ptype_t">
  115. <xs:attributeGroup ref="menu_item_g"/>
  116. <xs:attribute name="pattern" type="xs:string"/>
  117. <xs:attribute name="method" type="ptype_method_e" use="optional" default="regexp"/>
  118. <xs:attribute name="preprocess" type="ptype_preprocess_e" use="optional" default="none"/>
  119. </xs:complexType>
  120. <!--
  121. *******************************************************
  122. * <VIEW> defines the contents of a specific CLI view.
  123. *
  124. * name - a textual name for the view
  125. *
  126. * prompt - a textual definition of the prompt to be
  127. * used whilst in this view.
  128. * NB. The prompt may contain environment
  129. * or dynamic variables which are expanded
  130. * before display.
  131. *
  132. * [depth] - a depth of nested view (uses for config).
  133. *
  134. * [restore] - restore the depth or view of commands
  135. * contained by this view
  136. ********************************************************
  137. -->
  138. <xs:simpleType name="restore_t">
  139. <xs:restriction base="xs:string">
  140. <xs:enumeration value="none"/>
  141. <xs:enumeration value="depth"/>
  142. <xs:enumeration value="view"/>
  143. </xs:restriction>
  144. </xs:simpleType>
  145. <xs:complexType name="view_t">
  146. <xs:sequence>
  147. <xs:element ref="NAMESPACE" minOccurs="0" maxOccurs="unbounded"/>
  148. <xs:element ref="COMMAND" minOccurs="0" maxOccurs="unbounded"/>
  149. </xs:sequence>
  150. <xs:attribute name="name" type="xs:string" use="required"/>
  151. <xs:attribute name="prompt" type="xs:string" use="optional"/>
  152. <xs:attribute name="depth" type="xs:string" use="optional" default="0"/>
  153. <xs:attribute name="restore" type="restore_t" use="optional" default="none"/>
  154. <xs:attribute name="access" type="xs:string" use="optional"/>
  155. </xs:complexType>
  156. <!--
  157. *******************************************************
  158. * <STARTUP> is used to define what happens when the CLI
  159. * is started. Any text held in a <DETAIL> sub-element will
  160. * be used as banner text, then any defined <ACTION> will be
  161. * executed. This action may provide Message Of The Day (MOTD)
  162. * type behaviour.
  163. *
  164. * view - defines the view which will be transitioned to, on
  165. * successful execution of any <ACTION> tag.
  166. *
  167. * [viewid] - defined the new value of the ${VIEWID} variable to
  168. * be used if a transition to a new view occurs.
  169. *
  170. * [default_shebang] - The default shebang for all commands.
  171. ********************************************************
  172. -->
  173. <xs:complexType name="startup_t">
  174. <xs:sequence>
  175. <xs:element ref="DETAIL" minOccurs="0"/>
  176. <xs:element ref="ACTION" minOccurs="0"/>
  177. </xs:sequence>
  178. <xs:attribute name="view" type="xs:string" use="required"/>
  179. <xs:attribute name="viewid" type="xs:string" use="optional"/>
  180. <xs:attribute name="default_shebang" type="xs:string" use="optional"/>
  181. <xs:attribute name="timeout" type="xs:string" use="optional"/>
  182. </xs:complexType>
  183. <!--
  184. *******************************************************
  185. * <COMMAND> is used to define a command within the CLI.
  186. *
  187. * name - a textual name for this command. (This may contain
  188. * spaces e.g. "display acl")
  189. *
  190. * help - a textual string which describes the purpose of the
  191. * command.
  192. *
  193. * [view] - defines the view which will be transitioned to, on
  194. * successful execution of any <ACTION> tag. By default the
  195. * current view stays in scope.
  196. *
  197. * [viewid] - defined the new value of the ${VIEWID} variable to
  198. * be used if a transition to a new view occurs. By default
  199. * the viewid will retain it's current value.
  200. *
  201. * [access] - defines the user group/level to which execution of this
  202. * command is restricted. By default there is no restriction.
  203. * The exact interpretation of this field is dependant on the
  204. * client of libclish but for example the clish and tclish
  205. * applications map this to the UNIX user groups.
  206. *
  207. * [escape_chars] - defines the characters which will be escaped (e.g. \$) before
  208. * being expanded as a variable. By default the following
  209. * characters will be escaped `|$<>&()#
  210. *
  211. * [args] - defines a parameter name to be used to gather the rest of the
  212. * command line after the formally defined parameters
  213. * (PARAM elements). The formatting of this parameter is a raw
  214. * string containing as many words as there are on the rest of the
  215. * command line.
  216. *
  217. * [args_help] - a textual string which describes the purpose of the 'args'
  218. * parameter. If the "args" attribute is given then this MUST be
  219. * given also.
  220. *
  221. * [lock] - the boolean field that specify to lock lockfile while
  222. * command execution or not. Default is true.
  223. *
  224. ********************************************************
  225. -->
  226. <xs:complexType name="command_t">
  227. <xs:sequence>
  228. <xs:element ref="DETAIL" minOccurs="0"/>
  229. <xs:element ref="PARAM" minOccurs="0" maxOccurs="unbounded"/>
  230. <xs:element ref="CONFIG" minOccurs="0"/>
  231. <xs:element ref="ACTION" minOccurs="0"/>
  232. </xs:sequence>
  233. <xs:attributeGroup ref="menu_item_g"/>
  234. <xs:attribute name="ref" type="xs:string" use="optional"/>
  235. <xs:attribute name="view" type="xs:string" use="optional"/>
  236. <xs:attribute name="viewid" type="xs:string" use="optional"/>
  237. <xs:attribute name="access" type="xs:string" use="optional"/>
  238. <xs:attribute name="args" type="xs:string" use="optional"/>
  239. <xs:attribute name="args_help" type="xs:string" use="optional"/>
  240. <xs:attribute name="escape_chars" type="xs:string" use="optional"/>
  241. <xs:attribute name="lock" type="bool_t" use="optional" default="true"/>
  242. <xs:attribute name="interrupt" type="bool_t" use="optional" default="false"/>
  243. </xs:complexType>
  244. <!--
  245. *******************************************************
  246. * <PARAM> This tag is used to define a parameter for a command.
  247. *
  248. * name - a textual name for this parameter.
  249. *
  250. * help - a textual string which describes the purpose of the
  251. * parameter.
  252. *
  253. * ptype - Reference to a PTYPE name. This parameter will be
  254. * validated against the syntax specified for that type.
  255. * The special value of "" indicates the parameter is a boolean flag.
  256. * The verbatim presence of the texual name on the command line
  257. * simply controls the conditional variable expansion for this
  258. * parameter.
  259. *
  260. * [mode] - Parameter mode. It can be "common", "switch" or
  261. * "subcommand".
  262. *
  263. * [prefix] - defines the prefix for an optional parameter. A prefix
  264. * with this value on the command line will signify the presence
  265. * of an additional argument which will be validated as the
  266. * value of this parameter.
  267. *
  268. * [optional]- Specify whether parameter is optional. The allowed values
  269. * is "true" or "false". It false by default.
  270. *
  271. * [default] - defines a default value for a parameter. Any parameters
  272. * at the end of command line which have default values need
  273. * not explicitly be entered.
  274. *
  275. * [value] - defines the user's value for subcommand. If this option
  276. * is defined the entered parameter will be compared to this
  277. * value instead the "name" field. If this field is defined
  278. * the mode of PARAM will be forced to "subcommand". The
  279. * feature is implemented to support subcommands with the
  280. * same names.
  281. *
  282. * [hidden] - define the visibility of the parameter while ${__line}
  283. * and ${__params} auto variables expanding. The allowed values
  284. * is "true" and "false".
  285. *
  286. * [test] - define the condition (see the description of 'test'
  287. * utility) to process this parameter.
  288. ********************************************************
  289. -->
  290. <xs:simpleType name="param_mode_t">
  291. <xs:restriction base="xs:string">
  292. <xs:enumeration value="common"/>
  293. <xs:enumeration value="switch"/>
  294. <xs:enumeration value="subcommand"/>
  295. </xs:restriction>
  296. </xs:simpleType>
  297. <xs:complexType name="param_t">
  298. <xs:sequence>
  299. <xs:element ref="PARAM" minOccurs="0" maxOccurs="unbounded"/>
  300. </xs:sequence>
  301. <xs:attributeGroup ref="menu_item_g"/>
  302. <xs:attribute name="ptype" type="xs:string" use="required"/>
  303. <xs:attribute name="default" type="xs:string" use="optional"/>
  304. <xs:attribute name="prefix" type="xs:string" use="optional"/>
  305. <xs:attribute name="mode" type="param_mode_t" use="optional" default="common"/>
  306. <xs:attribute name="optional" type="bool_t" use="optional" default="false"/>
  307. <xs:attribute name="value" type="xs:string" use="optional"/>
  308. <xs:attribute name="hidden" type="bool_t" use="optional" default="false"/>
  309. <xs:attribute name="test" type="xs:string" use="optional"/>
  310. <xs:attribute name="completion" type="xs:string" use="optional"/>
  311. </xs:complexType>
  312. <!--
  313. ********************************************************
  314. * <ACTION> specifies the action to be taken for
  315. * a command.
  316. *
  317. * The textual contents of the tag are variable expanded
  318. * (environment, dynamic and parameter) the the resulting
  319. * text is interpreted by the client's script interpreter.
  320. *
  321. * In addition the optional 'builtin' attribute can specify
  322. * the name of an internal command which will be invoked
  323. * instead of the client's script handler.
  324. *
  325. * NB. for security reasons any special shell characters
  326. * (e.g. $|<>`) are escaped before evaluation.
  327. *
  328. * [builtin] - specify the name of an internally registered
  329. * function. The content of the ACTION tag is
  330. * taken as the arguments to this builtin function.
  331. *
  332. * [shebang] - specify the programm to execute the action
  333. * script.
  334. ********************************************************
  335. -->
  336. <xs:complexType name="action_t">
  337. <xs:simpleContent>
  338. <xs:extension base="xs:string">
  339. <xs:attribute name="builtin" type="xs:string" use="optional"/>
  340. <xs:attribute name="shebang" type="xs:string" use="optional"/>
  341. </xs:extension>
  342. </xs:simpleContent>
  343. </xs:complexType>
  344. <!--
  345. ********************************************************
  346. * <OVERVIEW> specifies a textual description of the shell.
  347. *
  348. * This should provide instructions about key bindings and
  349. * escape sequences which can be used in the CLI.
  350. *
  351. ********************************************************
  352. -->
  353. <xs:simpleType name="overview_t">
  354. <xs:restriction base="xs:string">
  355. <xs:whiteSpace value="preserve"/>
  356. </xs:restriction>
  357. </xs:simpleType>
  358. <!--
  359. ********************************************************
  360. * <DETAIL> specifies a textual description.
  361. *
  362. * This may be used within the scope of a <COMMAND>
  363. * element, in which case it would typically contain
  364. * detailed usage instructions including examples.
  365. *
  366. * This may also be used within the scope of a <STARTUP>
  367. * element, in which case the text is used as the banner
  368. * details which are displayed on shell startup. This is
  369. * shown before any specified <ACTION> is executed.
  370. *
  371. * This text may also be used in the production of user manuals.
  372. ********************************************************
  373. -->
  374. <xs:simpleType name="detail_t">
  375. <xs:restriction base="xs:string">
  376. <xs:whiteSpace value="preserve"/>
  377. </xs:restriction>
  378. </xs:simpleType>
  379. <!--
  380. *******************************************************
  381. * <NAMESPACE> import commands from specific view to current view.
  382. *
  383. * ref - the view to import commands from
  384. *
  385. * [prefix] - the prefix for imported commands
  386. *
  387. * [prefix_help] - the help for namespace prefix
  388. *
  389. * [help] - a boolean flag to use imported
  390. * commands while help
  391. *
  392. * [completion] - a boolean flag to use imported
  393. * commands while completion
  394. *
  395. * [context_help] - a boolean flag to use imported
  396. * commands while context help
  397. *
  398. * [inherit] - a boolean flag to inherit nested
  399. * namespace commands recursively
  400. ********************************************************
  401. -->
  402. <xs:complexType name="namespace_t">
  403. <xs:attribute name="ref" type="xs:string" use="required"/>
  404. <xs:attribute name="prefix" type="xs:string" use="optional"/>
  405. <xs:attribute name="prefix_help" type="xs:string" use="optional"/>
  406. <xs:attribute name="help" type="bool_t" use="optional" default="false"/>
  407. <xs:attribute name="completion" type="bool_t" use="optional" default="true"/>
  408. <xs:attribute name="context_help" type="bool_t" use="optional" default="false"/>
  409. <xs:attribute name="inherit" type="bool_t" use="optional" default="true"/>
  410. <xs:attribute name="access" type="xs:string" use="optional"/>
  411. </xs:complexType>
  412. <!--
  413. *******************************************************
  414. * <CONFIG> Specify the config operation.
  415. *
  416. * operation - config operation to perform
  417. *
  418. ********************************************************
  419. -->
  420. <xs:simpleType name="operation_t">
  421. <xs:restriction base="xs:string">
  422. <xs:enumeration value="none"/>
  423. <xs:enumeration value="set"/>
  424. <xs:enumeration value="unset"/>
  425. <xs:enumeration value="dump"/>
  426. </xs:restriction>
  427. </xs:simpleType>
  428. <xs:complexType name="config_t">
  429. <xs:attribute name="operation" type="operation_t" use="optional" default="set"/>
  430. <xs:attribute name="priority" type="xs:string" use="optional" default="0x7f00"/>
  431. <xs:attribute name="pattern" type="xs:string" use="optional" default="^${__cmd}"/>
  432. <xs:attribute name="file" type="xs:string" use="optional" default="startup-config"/>
  433. <xs:attribute name="splitter" type="bool_t" use="optional" default="true"/>
  434. <xs:attribute name="sequence" type="xs:string" use="optional" default="0"/>
  435. <xs:attribute name="unique" type="bool_t" use="optional" default="true"/>
  436. <xs:attribute name="depth" type="xs:string" use="optional"/>
  437. </xs:complexType>
  438. <!--
  439. *******************************************************
  440. * <VAR> Specify the variable.
  441. *
  442. *
  443. *
  444. ********************************************************
  445. -->
  446. <xs:complexType name="var_t">
  447. <xs:sequence>
  448. <xs:element ref="ACTION" minOccurs="0"/>
  449. </xs:sequence>
  450. <xs:attributeGroup ref="menu_item_g"/>
  451. <xs:attribute name="value" type="xs:string" use="optional"/>
  452. <xs:attribute name="dynamic" type="bool_t" use="optional" default="false"/>
  453. </xs:complexType>
  454. <!--
  455. *******************************************************
  456. * <WATCHDOG> is used to recover system after errors.
  457. *
  458. ********************************************************
  459. -->
  460. <xs:complexType name="wdog_t">
  461. <xs:sequence>
  462. <xs:element ref="ACTION" minOccurs="1"/>
  463. </xs:sequence>
  464. </xs:complexType>
  465. </xs:schema>