strobj.h

Go to the documentation of this file.

/*
# This file is Copyright 2003, 2006, 2007, 2009 Dean Hall.
#
# This file is part of the PyMite VM.
# The PyMite VM is free software: you can redistribute it and/or modify
# it under the terms of the GNU GENERAL PUBLIC LICENSE Version 2.
#
# The PyMite VM 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.
# A copy of the GNU GENERAL PUBLIC LICENSE Version 2
# is seen in the file COPYING in this directory.
*/


#ifndef __STRING_H__
#define __STRING_H__


#define USE_STRING_CACHE 1


#define string_loadFromImg(ms, paddr, r_pstring) \
    string_create((ms), (paddr), (int16_t)-1, (int16_t)1, (r_pstring))

#define string_new(paddr, r_pstring) \
    string_create(MEMSPACE_RAM, (uint8_t const **)(paddr), 0, (int16_t)1, (r_pstring))

#define string_newWithLen(paddr, len, r_pstring) \
    string_create(MEMSPACE_RAM, (uint8_t const **)(paddr), (len), (int16_t)1, \
                  (r_pstring))

#define string_replicate(paddr, n, r_pstring) \
    string_create(MEMSPACE_RAM, (paddr), (uint8_t)0, (n), (r_pstring))

/***************************************************************
 * Types
 **************************************************************/

typedef struct PmString_s
{
    PmObjDesc_t od;

    uint16_t length;

#if USE_STRING_CACHE

    struct PmString_s *next;
#endif                          /* USE_STRING_CACHE */

    uint8_t val[1];
} PmString_t,
 *pPmString_t;


/***************************************************************
 * Prototypes
 **************************************************************/

PmReturn_t string_create(PmMemSpace_t memspace, uint8_t const **paddr,
                         int16_t len, int16_t n, pPmObj_t *r_pstring);
;

PmReturn_t string_newFromChar(uint8_t const c, pPmObj_t *r_pstring);

int8_t string_compare(pPmString_t, pPmString_t);

#ifdef HAVE_PRINT

PmReturn_t string_print(pPmObj_t pstr, uint8_t marshall);
#endif /* HAVE_PRINT */

PmReturn_t string_cacheInit(void);


PmReturn_t string_getCache(pPmString_t **r_ppstrcache);

PmReturn_t
string_concat(pPmString_t pstr1, pPmString_t pstr2, pPmObj_t *r_pstring);

#ifdef HAVE_STRING_FORMAT

PmReturn_t string_format(pPmString_t pstr, pPmObj_t parg, pPmObj_t *r_pstring);
#endif /* HAVE_STRING_FORMAT */

#endif /* __STRING_H__ */