ytStrArray.h

/*
  ytStrArray.{h,c} : Expanable char * Array
  Copyright (C) 2016, Yoshinori Tamada <tamada  A T  ytlab.jp>
  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 Kyoto University 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 HOLDER 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.
*/
 
#ifndef __YTLIB_STR_ARRAY_H
#define __YTLIB_STR_ARRAY_H
 
#include <stdio.h>
#include <stdlib.h>
 
#include "lang/ytObject.h"
 
#define ytStrArray_ERROR_VALUE ((size_t) -1)
 
/*typedef struct ytStrArray_t ytStrArray;*/
#ifndef DOXY
typedef struct ytStrArray_t {
  ytObject obj;
  char * * ptr;
  size_t size;
  size_t buff_size;
} ytStrArray;
#endif
 
#ifdef YTLIB_MEMCHECK
#define ytStrArray_new() ytStrArray_newm(__FILE__,__LINE__)
ytStrArray * ytStrArray_newm(const char * file, int line);
#else
ytStrArray * ytStrArray_new();
#endif
void ytStrArray_delete(ytStrArray * this);
void ytStrArray_deletev(void * this);
void ytStrArray_deleteAll(ytStrArray * this);
void ytStrArray_deleteAllv(void * this);
ytStrArray * ytStrArray_clone(const ytStrArray * this);
ytObject * ytStrArray_cloneI(const ytObject * this);
ytStrArray * ytStrArray_arrayNew(size_t size);
void ytStrArray_arrayDelete(ytStrArray * this, size_t size);
void ytStrArray_dump(const ytStrArray * this, FILE * fp);
void ytStrArray_dumpv(const ytObject * this, FILE * fp);
size_t ytStrArray_size(const ytStrArray * this);
size_t ytStrArray_buffSize(const ytStrArray * this);
size_t ytStrArray_memSize(const ytStrArray * this);
size_t ytStrArray_arrayMemSize(const ytStrArray * this, size_t n);
void ytStrArray_clear(ytStrArray * this);
ytStrArray * ytStrArray_setBuffSize(ytStrArray * this, size_t new_size);
void ytStrArray_add(ytStrArray * this, char * value);
void ytStrArray_addStrArray(ytStrArray * this, const ytStrArray * values);
void ytStrArray_set(ytStrArray * this, size_t index, char * value);
void ytStrArray_setSize(ytStrArray * this, size_t size);
void ytStrArray_insert(ytStrArray * this, size_t index, char * value);
char * ytStrArray_remove(ytStrArray * this, size_t index);
void ytStrArray_copy(ytStrArray * this, const ytStrArray * src);
void ytStrArray_copyArray(ytStrArray * this, size_t index, const char * * array, size_t size);
char * ytStrArray_get(const ytStrArray * this, size_t index);
char * ytStrArray_pop(ytStrArray * this);
char * * ytStrArray_ptr(ytStrArray * this);
void ytStrArray_sort(ytStrArray * this);
size_t ytStrArray_find(const ytStrArray * this, const char * v);
void ytStrArray_print(const ytStrArray * this, FILE * fp, char * delim);
int ytStrArray_sprint(const ytStrArray * this, char * buff, size_t size, char * delim);
ytObject * ytStrArray_obj(ytStrArray * this);
ytObject * ytStrArray_pObj(ytStrArray ** ptr);
ytStrArray * ytStrArray_from(ytObject * this);
ytStrArray ** ytStrArray_objP(ytObject * this);
size_t ytStrArray_memorySize(const ytStrArray * this);
size_t ytStrArray_memorySizeI(const ytObject * this);
ytByte * ytStrArray_serializeI(const ytObject * obj, ytByte ** pptr);
ytByte * ytStrArray_serialize(const ytStrArray * this, ytByte ** pptr);
ytStrArray * ytStrArray_deserialize(ytByte ** const pptr);
ytObject * ytStrArray_deserializeI(ytByte ** const ptr);
#ifdef USE_MPI
#include <mpi.h>
void ytStrArray_MPI_Bcast(ytStrArray ** pObj, int root, MPI_Comm comm);
void ytStrArray_MPI_BcastI(ytObject ** pObject, int root, MPI_Comm comm);
#endif
 
#endif /* __YTLIB_STR_ARRAY_H */