src/st-descriptor.h

   1 /*
   2  * st-descriptor.h
   3  *
   4  * Copyright (C) 2008 Vincent Geddes
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23 */
  24
  25 #ifndef __ST_DESCRIPTOR_H__
  26 #define __ST_DESCRIPTOR_H__
  27
  28 #include <st-types.h>
  29
  30 typedef enum st_format
  31 {
  32     ST_FORMAT_OBJECT,
  33     ST_FORMAT_FLOAT,
  34     ST_FORMAT_LARGE_INTEGER,
  35     ST_FORMAT_ARRAY,
  36     ST_FORMAT_BYTE_ARRAY,
  37     ST_FORMAT_FLOAT_ARRAY,
  38     ST_FORMAT_INTEGER_ARRAY,
  39     ST_FORMAT_WORD_ARRAY,
  40     ST_FORMAT_CONTEXT,
  41
  42     ST_NUM_FORMATS
  43 } st_format;
  44
  45 struct st_descriptor
  46 {
  47     st_oop  (* allocate) (st_oop class);
  48
  49     st_oop  (* allocate_arrayed) (st_oop class,
  50                                   st_smi size);
  51
  52     st_uint (* size) (st_oop object);
  53
  54     void    (* contents) (st_oop object, st_oop **oops, st_uint *size);
  55
  56 };
  57
  58 typedef const struct st_descriptor st_descriptor;
  59
  60 extern st_descriptor *st_descriptors[ST_NUM_FORMATS];
  61
  62 #endif /* __ST_DESCRIPTOR_H__ */