klish.xsd 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <xs:schema
  3. xmlns:xs="http://www.w3.org/2001/XMLSchema"
  4. xmlns="https://klish.libcode.org/klish3"
  5. targetNamespace="https://klish.libcode.org/klish3">
  6. <xs:annotation>
  7. <xs:appinfo>XML schema for klish configuration files</xs:appinfo>
  8. <xs:documentation xml:lang="en">
  9. The klish utility uses XML files for configuration. This schema
  10. allows to validate klish XML files. To check XML files use the
  11. following command:
  12. 'xmllint --schema /path/to/klish.xsd --noout *.xml'
  13. </xs:documentation>
  14. <xs:documentation xml:lang="ru">
  15. Утилита klish использует формат XML для своих конфигурационных
  16. файлов. Схема позволяет проверить конфигурационные XML файлы
  17. на корректность. Следующая команда выполнит проверку:
  18. 'xmllint --schema /path/to/klish.xsd --noout *.xml'
  19. </xs:documentation>
  20. </xs:annotation>
  21. <xs:element name="KLISH" type="klish_t"/>
  22. <xs:element name="PLUGIN" type="plugin_t"/>
  23. <xs:element name="HOTKEY" type="hotkey_t"/>
  24. <xs:element name="ACTION" type="action_t"/>
  25. <xs:element name="ENTRY" type="entry_t"/>
  26. <xs:element name="VIEW" type="view_t"/> <!-- Wrapper -->
  27. <xs:element name="COMMAND" type="command_t"/> <!-- Wrapper -->
  28. <xs:element name="FILTER" type="command_t"/> <!-- Wrapper -->
  29. <xs:element name="COND" type="command_t"/> <!-- Wrapper -->
  30. <xs:element name="COMPL" type="command_t"/> <!-- Wrapper -->
  31. <xs:element name="HELP" type="command_t"/> <!-- Wrapper -->
  32. <xs:element name="PROMPT" type="command_t"/> <!-- Wrapper -->
  33. <xs:element name="PTYPE" type="ptype_t"/> <!-- Wrapper -->
  34. <xs:element name="PARAM" type="param_t"/> <!-- Wrapper -->
  35. <xs:element name="SWITCH" type="param_t"/> <!-- Wrapper -->
  36. <xs:element name="SEQ" type="param_t"/> <!-- Wrapper -->
  37. <!--
  38. *******************************************************
  39. * <KLISH> is a top level container.
  40. ********************************************************
  41. -->
  42. <xs:group name="klish_group_t">
  43. <xs:choice>
  44. <xs:element ref="PLUGIN" minOccurs="0" maxOccurs="unbounded"/>
  45. <xs:element ref="HOTKEY" minOccurs="0" maxOccurs="unbounded"/>
  46. <xs:element ref="ENTRY" minOccurs="0" maxOccurs="unbounded"/>
  47. <xs:element ref="PTYPE" minOccurs="0" maxOccurs="unbounded"/>
  48. <xs:element ref="VIEW" minOccurs="0" maxOccurs="unbounded"/>
  49. </xs:choice>
  50. </xs:group>
  51. <xs:complexType name="klish_t">
  52. <xs:annotation>
  53. <xs:documentation xml:lang="en">
  54. 'KLISH' is the top level container.
  55. </xs:documentation>
  56. <xs:documentation xml:lang="ru">
  57. Тег 'KLISH' - контейнер верхнего уровня. Все остальные
  58. теги должны быть вложенными.
  59. </xs:documentation>
  60. </xs:annotation>
  61. <!-- Any order of tags and any number -->
  62. <xs:sequence>
  63. <xs:group ref="klish_group_t" minOccurs="0" maxOccurs="unbounded"/>
  64. </xs:sequence>
  65. </xs:complexType>
  66. <!--
  67. *******************************************************
  68. * <PLUGIN> is used to dynamically load plugins.
  69. * Plugin contains symbols that can be used for ACTIONs.
  70. *
  71. * name - Plugin name. If "file" attribute is not specified then plugin's
  72. * filename is autogenerated as "kplugin-<name>.so".
  73. *
  74. * [id] - Internal plugin name for references. Can be the same as "name".
  75. *
  76. * [file] - File name to use if standard autogenerated filename (using "name"
  77. * field) is not appropriate.
  78. *
  79. * The content of PLUGIN tag can be used as a config file for this plugin.
  80. * Parsing of this content must be implemented within plugin's init.
  81. *
  82. ********************************************************
  83. -->
  84. <xs:complexType name="plugin_t">
  85. <xs:annotation>
  86. <xs:documentation xml:lang="en">
  87. Load plugin with symbols (functions).
  88. </xs:documentation>
  89. <xs:documentation xml:lang="ru">
  90. Загружает плугин для использования определяемых в нем
  91. символов (функций).
  92. </xs:documentation>
  93. </xs:annotation>
  94. <xs:simpleContent>
  95. <xs:extension base="xs:string">
  96. <xs:attribute name="name" type="xs:string" use="required"/>
  97. <xs:attribute name="id" type="xs:string" use="optional"/>
  98. <xs:attribute name="file" type="xs:string" use="optional"/>
  99. </xs:extension>
  100. </xs:simpleContent>
  101. </xs:complexType>
  102. <!--
  103. *******************************************************
  104. * <HOTKEY> is used to define hotkey actions
  105. *
  106. * key - Hot-key
  107. *
  108. * cmd - Text string defines command to execute on pressing hot-key. It's like
  109. * a common user CLI input. This string will be interpreted by CLI engine.
  110. *
  111. ********************************************************
  112. -->
  113. <xs:complexType name="hotkey_t">
  114. <xs:attribute name="key" type="xs:string" use="required"/>
  115. <xs:attribute name="cmd" type="xs:string" use="required"/>
  116. </xs:complexType>
  117. <!--
  118. ********************************************************
  119. * <ACTION> specifies the action to be taken for
  120. * a command.
  121. *
  122. * In addition the optional 'sym' attribute can specify
  123. * the name of an internal command which will be invoked
  124. * to handle script.
  125. *
  126. * [sym="<symbol>"] - specify the name of an internally registered
  127. * function (symbol). The content of the ACTION tag is
  128. * taken as the arguments to this function. Plugins can define
  129. * these symbols. The "<symbol>" can be defined as "sym@plugin" i.e.
  130. * parental plugin can be defined explicitly.
  131. *
  132. * [lock="<name>"] - Named lock. It will use special lockfile while
  133. * action execution.
  134. *
  135. * [interrupt="true/false"] - The boolean field that specify that action can be
  136. * be interrupted by Ctrl^C. Default is false. Ignored for non-interactive
  137. * actions.
  138. *
  139. * [interactive="true/false"] - Is action interactive.
  140. *
  141. * [exec_on="fail/success/always/never"] - ACTION's execution depends on
  142. * return code of previous elements of ACTION chain. If the
  143. * condition is not met then ACTION will not be executed. The "always"
  144. * value means that ACTION will be always executed and chain return
  145. * code will be ignored. Default is "success".
  146. *
  147. * [update_retcode="true/false"] - The chain return value can be updated
  148. * by current ACTION's return code or ACTION's return code can be ignored.
  149. * Default is "true".
  150. *
  151. * [permanent="true/false"] - The klish can be invoked with dry-run option. In
  152. * this case all ACTIONs will be not actually executed but will always
  153. * return success. But some actions like navigation is necessary to be
  154. * executed in any case. Permanent flag will inform engine to always
  155. * execute ACTION.
  156. *
  157. * [sync="true/false"] - Common behaviour is to fork() process before ACTION
  158. * execution. But ACTION may be executed in-place (without fork()) if sync
  159. * flag is set to true. It's not recommended to use sync ACTIONs widely.
  160. * It's usefull for small fast functions only.
  161. *
  162. ********************************************************
  163. -->
  164. <xs:simpleType name="action_cond_t">
  165. <xs:restriction base="xs:string">
  166. <xs:enumeration value="fail"/>
  167. <xs:enumeration value="success"/>
  168. <xs:enumeration value="always"/>
  169. <xs:enumeration value="never"/>
  170. </xs:restriction>
  171. </xs:simpleType>
  172. <xs:complexType name="action_t">
  173. <xs:simpleContent>
  174. <xs:extension base="xs:string">
  175. <xs:attribute name="sym" type="xs:string" use="optional"/>
  176. <xs:attribute name="lock" type="xs:string" use="optional"/>
  177. <xs:attribute name="interrupt" type="xs:boolean" use="optional" default="false"/>
  178. <xs:attribute name="interactive" type="xs:boolean" use="optional" default="false"/>
  179. <xs:attribute name="exec_on" type="action_cond_t" use="optional" default="success"/>
  180. <xs:attribute name="update_retcode" type="xs:boolean" use="optional" default="true"/>
  181. <xs:attribute name="permanent" type="xs:boolean" use="optional" default="false"/>
  182. <xs:attribute name="sync" type="xs:boolean" use="optional" default="false"/>
  183. </xs:extension>
  184. </xs:simpleContent>
  185. </xs:complexType>
  186. <!--
  187. *******************************************************
  188. * <ENTRY> This tag is used to define wide class of elements.
  189. *
  190. * name - A text name for entry.
  191. *
  192. * [help] - A text string which describes the purpose of the entry.
  193. *
  194. * [container="true/false"] - If entry is container. Container entry can't
  195. * have parsable argument i.e. only container's children can be considered
  196. * as a candidates to be a appropriate instance for parsed argument.
  197. * For example VIEW is a container. It just structurizes commands but
  198. * are not commands itself. Another example of container is a SWITCH.
  199. * It describes parsing of child elements but has no special keyword
  200. * while user typing.
  201. *
  202. * [mode] - Entry mode. It can be "sequence", "switch", "empty". Default is
  203. * "sequence".
  204. *
  205. * [purpose] - Purpose of entry. It can be "common", "ptype", "prompt", "cond",
  206. * "completion", "help". Default is "common". Another "purposes" are
  207. * processed in a special ways.
  208. *
  209. * [min="<num>"] - Min number of entry occurence while user input parsing.
  210. * Default is 1.
  211. *
  212. * [max="<num>"] - Max number of entry occurence while user input parsing.
  213. * Default is 1.
  214. *
  215. * [ref="<reference>"] - Entry can reference another entry.
  216. *
  217. * [value="<val>"] - defines the user's value for subcommand. If this option
  218. * is defined the entered parameter will be compared to this
  219. * value instead the "name" field. If this field is defined
  220. * the mode of PARAM will be forced to "subcommand". The
  221. * feature is implemented to support subcommands with the
  222. * same names.
  223. *
  224. * [restore="true/false"] - Restore (or not) hierarchy level of executed
  225. * entry. Default is "false".
  226. *
  227. * [order="true/false"] - If order="true" then user can't enter previously declared
  228. * optional parameters after current validated parameter.
  229. * The allowed values is "true" or "false". It's false by default.
  230. *
  231. * [filter="true/false"] - Developer can define 'filter' command to filter stdout
  232. * of piped ("|") commands. Filter can't contain 'sync' ACTIONs. It will be
  233. * always fork()-ed. Only filters can be on the right hand to pipe "|".
  234. * Consider filters as a special type of commands.
  235. *
  236. ********************************************************
  237. -->
  238. <xs:simpleType name="entry_mode_t">
  239. <xs:restriction base="xs:string">
  240. <xs:enumeration value="sequence"/>
  241. <xs:enumeration value="switch"/>
  242. <xs:enumeration value="empty"/>
  243. </xs:restriction>
  244. </xs:simpleType>
  245. <xs:simpleType name="entry_purpose_t">
  246. <xs:restriction base="xs:string">
  247. <xs:enumeration value="common"/>
  248. <xs:enumeration value="ptype"/>
  249. <xs:enumeration value="prompt"/>
  250. <xs:enumeration value="cond"/>
  251. <xs:enumeration value="completion"/>
  252. <xs:enumeration value="help"/>
  253. </xs:restriction>
  254. </xs:simpleType>
  255. <xs:group name="entry_group_t">
  256. <xs:choice>
  257. <xs:element ref="HOTKEY" minOccurs="0" maxOccurs="unbounded"/>
  258. <xs:element ref="ACTION" minOccurs="0" maxOccurs="unbounded"/>
  259. <xs:element ref="ENTRY" minOccurs="0" maxOccurs="unbounded"/>
  260. <xs:element ref="PTYPE" minOccurs="0" maxOccurs="unbounded"/>
  261. <xs:element ref="VIEW" minOccurs="0" maxOccurs="unbounded"/>
  262. <xs:element ref="COMMAND" minOccurs="0" maxOccurs="unbounded"/>
  263. <xs:element ref="FILTER" minOccurs="0" maxOccurs="unbounded"/>
  264. <xs:element ref="PARAM" minOccurs="0" maxOccurs="unbounded"/>
  265. <xs:element ref="COND" minOccurs="0" maxOccurs="unbounded"/>
  266. <xs:element ref="COMPL" minOccurs="0" maxOccurs="unbounded"/>
  267. <xs:element ref="HELP" minOccurs="0" maxOccurs="unbounded"/>
  268. <xs:element ref="PROMPT" minOccurs="0" maxOccurs="unbounded"/>
  269. <xs:element ref="SWITCH" minOccurs="0" maxOccurs="unbounded"/>
  270. <xs:element ref="SEQ" minOccurs="0" maxOccurs="unbounded"/>
  271. </xs:choice>
  272. </xs:group>
  273. <xs:complexType name="entry_t">
  274. <!-- Any order of tags and any number -->
  275. <xs:sequence>
  276. <xs:group ref="entry_group_t" minOccurs="0" maxOccurs="unbounded"/>
  277. </xs:sequence>
  278. <xs:attribute name="name" type="xs:string" use="required"/>
  279. <xs:attribute name="help" type="xs:string" use="optional"/>
  280. <xs:attribute name="container" type="xs:boolean" use="optional" default="false"/>
  281. <xs:attribute name="mode" type="entry_mode_t" use="optional" default="switch"/>
  282. <xs:attribute name="purpose" type="entry_purpose_t" use="optional" default="common"/>
  283. <xs:attribute name="min" type="xs:string" use="optional" default="1"/>
  284. <xs:attribute name="max" type="xs:string" use="optional" default="1"/>
  285. <xs:attribute name="ref" type="xs:string" use="optional"/>
  286. <xs:attribute name="value" type="xs:string" use="optional"/>
  287. <xs:attribute name="restore" type="xs:boolean" use="optional" default="false"/>
  288. <xs:attribute name="order" type="xs:boolean" use="optional" default="false"/>
  289. <xs:attribute name="filter" type="xs:boolean" use="optional" default="false"/>
  290. </xs:complexType>
  291. <!--
  292. *******************************************************
  293. * <PTYPE> is used to define the syntax for a parameter type.
  294. *
  295. * See ENTRY tag for attributes description.
  296. *
  297. ********************************************************
  298. -->
  299. <xs:group name="ptype_group_t">
  300. <xs:choice>
  301. <xs:element ref="ACTION" minOccurs="0" maxOccurs="unbounded"/>
  302. <xs:element ref="ENTRY" minOccurs="0" maxOccurs="unbounded"/>
  303. <xs:element ref="COND" minOccurs="0" maxOccurs="unbounded"/>
  304. <xs:element ref="COMPL" minOccurs="0" maxOccurs="unbounded"/>
  305. <xs:element ref="HELP" minOccurs="0" maxOccurs="unbounded"/>
  306. </xs:choice>
  307. </xs:group>
  308. <xs:complexType name="ptype_t">
  309. <xs:sequence>
  310. <xs:group ref="ptype_group_t" minOccurs="0" maxOccurs="unbounded"/>
  311. </xs:sequence>
  312. <xs:attribute name="name" type="xs:string" use="optional"/>
  313. <xs:attribute name="help" type="xs:string" use="optional"/>
  314. <xs:attribute name="ref" type="xs:string" use="optional"/>
  315. <xs:attribute name="value" type="xs:string" use="optional"/>
  316. </xs:complexType>
  317. <!--
  318. *******************************************************
  319. * <VIEW> defines the contents of a specific CLI view.
  320. *
  321. * See ENTRY tag for attributes description.
  322. *
  323. ********************************************************
  324. -->
  325. <xs:group name="view_group_t">
  326. <xs:choice>
  327. <xs:element ref="HOTKEY" minOccurs="0" maxOccurs="unbounded"/>
  328. <xs:element ref="ENTRY" minOccurs="0" maxOccurs="unbounded"/>
  329. <xs:element ref="PTYPE" minOccurs="0" maxOccurs="unbounded"/>
  330. <xs:element ref="VIEW" minOccurs="0" maxOccurs="unbounded"/>
  331. <xs:element ref="COMMAND" minOccurs="0" maxOccurs="unbounded"/>
  332. <xs:element ref="FILTER" minOccurs="0" maxOccurs="unbounded"/>
  333. <xs:element ref="PARAM" minOccurs="0" maxOccurs="unbounded"/>
  334. <xs:element ref="COND" minOccurs="0" maxOccurs="unbounded"/>
  335. <xs:element ref="COMPL" minOccurs="0" maxOccurs="unbounded"/>
  336. <xs:element ref="HELP" minOccurs="0" maxOccurs="unbounded"/>
  337. <xs:element ref="PROMPT" minOccurs="0" maxOccurs="unbounded"/>
  338. <xs:element ref="SWITCH" minOccurs="0" maxOccurs="unbounded"/>
  339. <xs:element ref="SEQ" minOccurs="0" maxOccurs="unbounded"/>
  340. </xs:choice>
  341. </xs:group>
  342. <xs:complexType name="view_t">
  343. <xs:sequence>
  344. <xs:group ref="view_group_t" minOccurs="0" maxOccurs="unbounded"/>
  345. </xs:sequence>
  346. <xs:attribute name="name" type="xs:string" use="required"/>
  347. <xs:attribute name="help" type="xs:string" use="optional"/>
  348. <xs:attribute name="ref" type="xs:string" use="optional"/>
  349. </xs:complexType>
  350. <!--
  351. *******************************************************
  352. * <PARAM> This tag is used to define a parameter for a command.
  353. *
  354. * See ENTRY tag for attributes description.
  355. *
  356. ********************************************************
  357. -->
  358. <xs:group name="param_group_t">
  359. <xs:choice>
  360. <xs:element ref="ACTION" minOccurs="0" maxOccurs="unbounded"/>
  361. <xs:element ref="ENTRY" minOccurs="0" maxOccurs="unbounded"/>
  362. <xs:element ref="PTYPE" minOccurs="0" maxOccurs="unbounded"/>
  363. <xs:element ref="VIEW" minOccurs="0" maxOccurs="unbounded"/>
  364. <xs:element ref="COMMAND" minOccurs="0" maxOccurs="unbounded"/>
  365. <xs:element ref="FILTER" minOccurs="0" maxOccurs="unbounded"/>
  366. <xs:element ref="PARAM" minOccurs="0" maxOccurs="unbounded"/>
  367. <xs:element ref="COND" minOccurs="0" maxOccurs="unbounded"/>
  368. <xs:element ref="COMPL" minOccurs="0" maxOccurs="unbounded"/>
  369. <xs:element ref="HELP" minOccurs="0" maxOccurs="unbounded"/>
  370. <xs:element ref="SWITCH" minOccurs="0" maxOccurs="unbounded"/>
  371. <xs:element ref="SEQ" minOccurs="0" maxOccurs="unbounded"/>
  372. </xs:choice>
  373. </xs:group>
  374. <xs:complexType name="param_t">
  375. <!-- Any order of tags and any number -->
  376. <xs:sequence>
  377. <xs:group ref="param_group_t" minOccurs="0" maxOccurs="unbounded"/>
  378. </xs:sequence>
  379. <xs:attribute name="name" type="xs:string" use="required"/>
  380. <xs:attribute name="help" type="xs:string" use="optional"/>
  381. <xs:attribute name="ptype" type="xs:string" use="optional"/>
  382. <xs:attribute name="mode" type="entry_mode_t" use="optional" default="sequence"/>
  383. <xs:attribute name="min" type="xs:string" use="optional" default="1"/>
  384. <xs:attribute name="max" type="xs:string" use="optional" default="1"/>
  385. <xs:attribute name="ref" type="xs:string" use="optional"/>
  386. <xs:attribute name="value" type="xs:string" use="optional"/>
  387. <xs:attribute name="order" type="xs:boolean" use="optional" default="false"/>
  388. </xs:complexType>
  389. <!--
  390. *******************************************************
  391. * <COMMAND> is used to define a command within the CLI.
  392. *
  393. * See ENTRY tag for attributes description.
  394. *
  395. ********************************************************
  396. -->
  397. <xs:complexType name="command_t">
  398. <!-- Any order of tags and any number -->
  399. <xs:sequence>
  400. <xs:group ref="entry_group_t" minOccurs="0" maxOccurs="unbounded"/>
  401. </xs:sequence>
  402. <xs:attribute name="name" type="xs:string" use="optional"/>
  403. <xs:attribute name="help" type="xs:string" use="optional"/>
  404. <xs:attribute name="mode" type="entry_mode_t" use="optional" default="sequence"/>
  405. <xs:attribute name="min" type="xs:string" use="optional" default="1"/>
  406. <xs:attribute name="max" type="xs:string" use="optional" default="1"/>
  407. <xs:attribute name="ref" type="xs:string" use="optional"/>
  408. <xs:attribute name="value" type="xs:string" use="optional"/>
  409. <xs:attribute name="restore" type="xs:boolean" use="optional" default="false"/>
  410. </xs:complexType>
  411. </xs:schema>