cmdline (merge-intel): support ctrl-w in librte_cmdline
[libcmdline.git] / src / lib / cmdline_parse.h
index 6b7fca9..30fe8e9 100644 (file)
@@ -1,3 +1,37 @@
+/*-
+ * Copyright (c) <2010>, Intel Corporation
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in
+ *   the documentation and/or other materials provided with the
+ *   distribution.
+ *
+ * - Neither the name of Intel Corporation nor the names of its
+ *   contributors may be used to endorse or promote products derived
+ *   from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
 /*
  * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
  * All rights reserved.
@@ -64,7 +98,7 @@ typedef struct cmdline_token_hdr cmdline_parse_token_hdr_t;
  * parsed chars on success and a negative value on error.
  *
  * complete_get_nb() returns the number of possible values for this
- * token if completion is possible. If it is NULL or if it returns 0, 
+ * token if completion is possible. If it is NULL or if it returns 0,
  * no completion is possible.
  *
  * complete_get_elt() copy in dstbuf (the size is specified in the
@@ -83,7 +117,7 @@ struct cmdline_token_ops {
        int (*complete_get_elt)(cmdline_parse_token_hdr_t *, int, char *, unsigned int);
        /** get help for this token (token, dstbuf, size) */
        int (*get_help)(cmdline_parse_token_hdr_t *, char *, unsigned int);
-};     
+};
 
 struct cmdline;
 /**
@@ -102,7 +136,7 @@ typedef struct cmdline_inst cmdline_parse_inst_t;
 
 /**
  * A context is identified by its name, and contains a list of
- * instruction 
+ * instruction
  *
  */
 typedef cmdline_parse_inst_t *cmdline_parse_ctx_t;
@@ -123,7 +157,7 @@ int cmdline_parse(struct cmdline *cl, const char *buf);
  * modifying *state until it returns CMDLINE_PARSE_COMPLETED_BUFFER or
  * CMDLINE_PARSE_COMPLETED_BUFFER.
  *
- * It returns < 0 on error. 
+ * It returns < 0 on error.
  *
  * Else it returns:
  *   - CMDLINE_PARSE_COMPLETED_BUFFER on completion (one possible