misc.h

Go to the documentation of this file.

// Copyright (C) 1999-2005 Open Source Telecom Corporation.
// Copyright (C) 2006-2010 David Sugar, Tycho Softworks.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program 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 this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// As a special exception, you may use this file as part of a free software
// library without restriction.  Specifically, if other files instantiate
// templates or use macros or inline functions from this file, or you compile
// this file and link it with other files to produce an executable, this
// file does not by itself cause the resulting executable to be covered by
// the GNU General Public License.  This exception does not however
// invalidate any other reasons why the executable file might be covered by
// the GNU General Public License.
//
// This exception applies only to the code released under the name GNU
// Common C++.  If you copy code from other releases into a copy of GNU
// Common C++, as the General Public License permits, the exception does
// not apply to the code that you add in this way.  To avoid misleading
// anyone as to the status of such modified files, you must delete
// this exception notice from them.
//
// If you write modifications of your own for GNU Common C++, it is your choice
// whether to permit this exception to apply to your modifications.
// If you do not wish that, delete this exception notice.
//

#ifndef CCXX_MISC_H_
#define CCXX_MISC_H_

#ifndef CCXX_MISSING_H_
#include <cc++/missing.h>
#endif

#ifndef CCXX_THREAD_H_
#include <cc++/thread.h>
#endif

#define KEYDATA_INDEX_SIZE  97
#define KEYDATA_PAGER_SIZE  512

#if defined(PATH_MAX)
#if PATH_MAX > 512
#define KEYDATA_PATH_SIZE   512
#else
#define KEYDATA_PATH_SIZE   PATH_MAX
#endif
#else
#define KEYDATA_PATH_SIZE   256
#endif

#ifdef  CCXX_NAMESPACES
namespace ost {
#endif

class __EXPORT Runlist;
class __EXPORT Runable;

class __EXPORT MemPager
{
private:
    friend class String;
    friend class MemPagerObject;

    size_t pagesize;
    unsigned int pages;

    struct _page {
        struct _page *next;
        size_t used;
    } *page;

protected:
    virtual void* first(size_t size);

    virtual void* alloc(size_t size);

    char* first(char *str);

    char* alloc(const char *str);

    MemPager(size_t pagesize = 4096);

    void purge(void);

    void clean(void);

    virtual ~MemPager();

public:
    inline int getPages(void)
        {return pages;};
};

class __EXPORT StackPager : protected MemPager
{
private:
    typedef struct frame {
        struct frame *next;
        char data[1];
    }   frame_t;

    frame_t *stack;

public:
    StackPager(size_t pagesize);

    void *push(const void *object, size_t size);

    void *push(const char *string);

    void *pull(void);

    void purge(void);
};

class __EXPORT SharedMemPager : public MemPager, public Mutex
{
protected:
    SharedMemPager(size_t pagesize = 4096, const char *name = NULL);

    void purge(void);

    void* first(size_t size);

    void* alloc(size_t size);
};

__EXPORT void endKeydata(void);

class __EXPORT Keydata : protected MemPager
{
public:
#ifdef  CCXX_PACKED
#pragma pack(1)
#endif

    struct Keyval {
        Keyval *next;
        char val[1];
    };

    struct Keysym {
        Keysym *next;
        Keyval *data;
        const char **list;
        short count;
        char sym[1];
    };

    struct Define {
        const char *keyword;
        const char *value;
    };

#ifdef  CCXX_PACKED
#pragma pack()
#endif

private:
    static std::ifstream *cfgFile;
    static char lastpath[KEYDATA_PATH_SIZE + 1];
    static int count;
    static int sequence;

    int link;

    Keysym *keys[KEYDATA_INDEX_SIZE];

    unsigned getIndex(const char *sym);

protected:
    Keysym* getSymbol(const char *sym, bool create);

public:
    void load(const char *keypath);

    void loadPrefix(const char *prefix, const char *keypath);

    void loadFile(const char *filepath, const char *keys = NULL, const char *pre = NULL);

    void load(Define *pairs);

    Keydata();

    Keydata(const char *keypath);

    Keydata(Define *pairs, const char *keypath = NULL);

    virtual ~Keydata();

    void unlink(void);

    int getCount(const char *sym);

    const char* getFirst(const char *sym);

    const char* getLast(const char *sym);

    bool isKey(const char *sym);

    const char *getString(const char *sym, const char *def = NULL);

    long getLong(const char *sym, long def = 0);

    bool getBool(const char *key);

    double getDouble(const char *key, double def = 0.);

    unsigned getIndex(char **data, unsigned max);

    unsigned getCount(void);

    void setValue(const char *sym, const char *data);

    const char * const* getList(const char *sym);

    void clrValue(const char *sym);

    inline const char *operator[](const char *keyword)
        {return getLast(keyword);};

    static void end(void);

    friend inline void endKeydata(void)
        {Keydata::end();};
};

class __EXPORT MemPagerObject
{
public:
    inline void *operator new(size_t size, MemPager &pager)
        {return pager.alloc(size);};

    inline void *operator new[](size_t size, MemPager &pager)
        {return pager.alloc(size);};

    inline void operator delete(void *) {};

    inline void operator delete[](void *) {};
};

class __EXPORT Assoc
{
private:
    struct entry {
        const char *id;
        entry *next;
        void *data;
    };

    entry *entries[KEYDATA_INDEX_SIZE];

protected:
    Assoc();
    virtual ~Assoc();

    void clear(void);

    virtual void *getMemory(size_t size) = 0;

public:
    void *getPointer(const char *id) const;
    void setPointer(const char *id, void *data);
};

class __EXPORT Runlist : public Mutex
{
private:
    Runable *first, *last;

protected:
    unsigned limit, used;
    void check(void);

public:
    Runlist(unsigned count = 1);

    bool add(Runable *run);

    void del(Runable *run);

    void set(unsigned limit);
};

class __EXPORT Runable
{
private:
    friend class Runlist;
    Runlist *list;
    Runable *next, *prev;

protected:
    Runable();
    virtual ~Runable();

    virtual void ready(void) = 0;

public:
    bool starting(Runlist *list);

    void stoping(void);
};

#ifdef  CCXX_NAMESPACES
}
#endif

#endif