ultimecia

A ps1 emulator in c
Log | Files | Refs

linenoise.h (4527B)

      1 /* linenoise.h -- VERSION 1.0
      2  *
      3  * Guerrilla line editing library against the idea that a line editing lib
      4  * needs to be 20,000 lines of C code.
      5  *
      6  * See linenoise.c for more information.
      7  *
      8  * ------------------------------------------------------------------------
      9  *
     10  * Copyright (c) 2010-2023, Salvatore Sanfilippo <antirez at gmail dot com>
     11  * Copyright (c) 2010-2013, Pieter Noordhuis <pcnoordhuis at gmail dot com>
     12  *
     13  * All rights reserved.
     14  *
     15  * Redistribution and use in source and binary forms, with or without
     16  * modification, are permitted provided that the following conditions are
     17  * met:
     18  *
     19  *  *  Redistributions of source code must retain the above copyright
     20  *     notice, this list of conditions and the following disclaimer.
     21  *
     22  *  *  Redistributions in binary form must reproduce the above copyright
     23  *     notice, this list of conditions and the following disclaimer in the
     24  *     documentation and/or other materials provided with the distribution.
     25  *
     26  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     27  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     28  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     29  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     30  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     31  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     32  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     33  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     34  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     35  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     36  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     37  */
     38 
     39 #ifndef __LINENOISE_H
     40 #define __LINENOISE_H
     41 
     42 #ifdef __cplusplus
     43 extern "C" {
     44 #endif
     45 
     46 #include <stddef.h> /* For size_t. */
     47 
     48 extern char *linenoiseEditMore;
     49 
     50 /* The linenoiseState structure represents the state during line editing.
     51  * We pass this state to functions implementing specific editing
     52  * functionalities. */
     53 struct linenoiseState {
     54     int in_completion;  /* The user pressed TAB and we are now in completion
     55                          * mode, so input is handled by completeLine(). */
     56     size_t completion_idx; /* Index of next completion to propose. */
     57     int ifd;            /* Terminal stdin file descriptor. */
     58     int ofd;            /* Terminal stdout file descriptor. */
     59     char *buf;          /* Edited line buffer. */
     60     size_t buflen;      /* Edited line buffer size. */
     61     const char *prompt; /* Prompt to display. */
     62     size_t plen;        /* Prompt length. */
     63     size_t pos;         /* Current cursor position. */
     64     size_t oldpos;      /* Previous refresh cursor position. */
     65     size_t len;         /* Current edited line length. */
     66     size_t cols;        /* Number of columns in terminal. */
     67     size_t oldrows;     /* Rows used by last refrehsed line (multiline mode) */
     68     int history_index;  /* The history index we are currently editing. */
     69 };
     70 
     71 typedef struct linenoiseCompletions {
     72   size_t len;
     73   char **cvec;
     74 } linenoiseCompletions;
     75 
     76 /* Non blocking API. */
     77 int linenoiseEditStart(struct linenoiseState *l, int stdin_fd, int stdout_fd, char *buf, size_t buflen, const char *prompt);
     78 char *linenoiseEditFeed(struct linenoiseState *l);
     79 void linenoiseEditStop(struct linenoiseState *l);
     80 void linenoiseHide(struct linenoiseState *l);
     81 void linenoiseShow(struct linenoiseState *l);
     82 
     83 /* Blocking API. */
     84 char *linenoise(const char *prompt);
     85 void linenoiseFree(void *ptr);
     86 
     87 /* Completion API. */
     88 typedef void(linenoiseCompletionCallback)(const char *, linenoiseCompletions *);
     89 typedef char*(linenoiseHintsCallback)(const char *, int *color, int *bold);
     90 typedef void(linenoiseFreeHintsCallback)(void *);
     91 void linenoiseSetCompletionCallback(linenoiseCompletionCallback *);
     92 void linenoiseSetHintsCallback(linenoiseHintsCallback *);
     93 void linenoiseSetFreeHintsCallback(linenoiseFreeHintsCallback *);
     94 void linenoiseAddCompletion(linenoiseCompletions *, const char *);
     95 
     96 /* History API. */
     97 int linenoiseHistoryAdd(const char *line);
     98 int linenoiseHistorySetMaxLen(int len);
     99 int linenoiseHistorySave(const char *filename);
    100 int linenoiseHistoryLoad(const char *filename);
    101 
    102 /* Other utilities. */
    103 void linenoiseClearScreen(void);
    104 void linenoiseSetMultiLine(int ml);
    105 void linenoisePrintKeyCodes(void);
    106 void linenoiseMaskModeEnable(void);
    107 void linenoiseMaskModeDisable(void);
    108 
    109 #ifdef __cplusplus
    110 }
    111 #endif
    112 
    113 #endif /* __LINENOISE_H */