klish.xsd 19 KB

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