/[svn]/linuxsampler/trunk/src/network/lscp_shell_reference.h
ViewVC logotype

Contents of /linuxsampler/trunk/src/network/lscp_shell_reference.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2534 - (show annotations) (download) (as text)
Sun Mar 9 21:34:03 2014 UTC (10 years ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 1675 byte(s)
* LSCP shell (WIP): Added initial support for built-in LSCP reference
  documentation, which will automatically show the relevant LSCP reference
  section on screen as soon as one specific LSCP command was detected while
  typing on the command line.
* Bumped version (1.0.0.svn37).

1 /*****************************************************************************
2 * *
3 * LSCP documentation reference built into LSCP shell. *
4 * *
5 * Copyright (c) 2014 Christian Schoenebeck *
6 * *
7 * This program is part of LinuxSampler and released under the same terms. *
8 * *
9 *****************************************************************************/
10
11 #ifndef LSCP_SHELL_REFERENCE_H
12 #define LSCP_SHELL_REFERENCE_H
13
14 /**
15 * Encapsulates the reference documentation for exactly one LSCP command.
16 */
17 struct lscp_ref_entry_t {
18 const char* name; ///< shortened name of the LSCP command, acting as unique key (i.e. "CREATE AUDIO_OUTPUT_DEVICE").
19 const char* section; ///< Multi-line text block, being the actual documentation section of that LSCP command.
20 };
21
22 /**
23 * Returns the LSCP documentation reference section for the LSCP command given
24 * by @a cmd. A non complete LSCP command may be passed to this function. In the
25 * latter case this function will try to "guess" the LSCP command. If there is
26 * no unique match for the given LSCP command, then NULL is returned.
27 *
28 * @param cmd - LSCP command
29 * @returns LSCP reference section for given LSCP command or NULL if there is
30 * no unique match
31 */
32 lscp_ref_entry_t* lscp_reference_for_command(const char* cmd);
33
34 #endif // LSCP_SHELL_REFERENCE_H

  ViewVC Help
Powered by ViewVC