scotty.h

Go to the documentation of this file.

/*
===========================================================================
Copyright (C) 2006-2008 Leszek Godlewski

This file is part of libscotty source code.

libscotty is free software; you can redistribute it
and/or modify it under the terms of the GNU Lesser General Public License
as published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.

libscotty source code is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with libscotty; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
===========================================================================
*/

#ifndef _SCT_SCOTTY_H
#define _SCT_SCOTTY_H

#ifdef __cplusplus
extern "C" {
#endif // __cplusplus

#ifndef DOXYGEN_SHOULD_IGNORE_THIS
    #ifdef WIN32
        #define __EXPORT__ __declspec(dllexport)
    #elif (__GNUC__ >= 3)
        #define __EXPORT__ __attribute__((visibility("default")))
    #else
        #define __EXPORT__
    #endif
#endif  // DOXYGEN_SHOULD_IGNORE_THIS

#include <stddef.h> // for size_t

#define SCT_VERSION_MAJOR           0

#define SCT_VERSION_MINOR           1

#define SCT_VERSION_PATCH           1

#define SCT_VERSION(x)              { \
                                        (x)->major = SCT_VERSION_MAJOR; \
                                        (x)->minor = SCT_VERSION_MINOR; \
                                        (x)->patch = SCT_VERSION_PATCH; \
                                    }

#define SCT_MAX_PROMPT              64      // max length of the command prompt

#define SCT_CMDLINE_BUFFER_SIZE     1024    // max chars in a command line

#define SCT_PRINTF_BUFFER_SIZE      32768   // SCT_Printf buffer size

// error codes
#define SCTE_NO_ERROR                   0

#define SCTE_ERROR_CREATING_WINDOW      1   // curses initialization failed

#define SCTE_INVALID_WINDOW_ID          2   // invalid window ID supplied to SCT_GetWindowHandle

#define SCTE_MEMORY_ALLOCATION_FAILED   3   // a gMem.Alloc call returned NULL

typedef enum {
    SCT_SCREEN,
    SCT_OUTPUT,
    SCT_INPUT
} SCT_window_t;

typedef struct SCT_allocator_s {
    void    (*Init)(void);
    void    (*Close)(void);
    void    *(*Alloc)(size_t size);
    void    (*Free)(void *ptr);
} SCT_allocator_t;

typedef struct SCT_version_s {
    int     major;
    int     minor;
    int     patch;
} SCT_version_t;

__EXPORT__ int      SCT_Init(void);

__EXPORT__ int      SCT_IsInit(void);

__EXPORT__ void     SCT_GetLinkedVersion(SCT_version_t *ver);

__EXPORT__ int      SCT_SetAllocator(SCT_allocator_t *alloc);

__EXPORT__ void     SCT_SetCommandHandlerFunction(void (*cmdEvFunc)(const char *cmd));

__EXPORT__ int      SCT_SetHistorySize(unsigned int size);

__EXPORT__ void     SCT_ClearHistory(void);

__EXPORT__ void     *SCT_GetWindowHandle(SCT_window_t window);

__EXPORT__ int      SCT_GetError(void);

__EXPORT__ int      SCT_AddCompletionEntry(const char *str);

__EXPORT__ int      SCT_RemoveCompletionEntry(const char *str);

__EXPORT__ void     SCT_SetPrompt(const char *prompt);

__EXPORT__ void     SCT_Echo(const char *str);

__EXPORT__ void     SCT_Printf(const char *fmt, ...);

__EXPORT__ void     SCT_ClearScreen(void);

__EXPORT__ int      SCT_Input(void);

__EXPORT__ int      SCT_Close(void);

#ifdef __cplusplus
}
#endif // __cplusplus

#endif // SCOTTY_H

---