1
0

clish.xsd 20 KB

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