clish.xsd 18 KB

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