libhed/types.h

   1 /* Basic libhed data types */
   2
   3 /* This is a libhed PUBLIC file.
   4  * This header file will be installed on the target system.
   5  * When you add new things here, make sure they start with hed_.
   6  */
   7
   8 /*
   9  * hed - Hexadecimal editor
  10  * Copyright (C) 2012  Petr Tesarik <petr@tesarici.cz>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of version 2 of the GNU General Public License as
  14  * published by the Free Software Foundation.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24  */
  25
  26 #ifndef LIBHED__TYPES_H
  27 #define LIBHED__TYPES_H
  28
  29 #include <libhed/config.h>
  30
  31 /*******************************************************************
  32  * UNSIGNED OFFSET TYPE
  33  */
  34
  35 #include <stdint.h>
  36
  37 /* If LFS is requested, define all offset types as 64-bit integers,
  38  * otherwise use the default size for the architecture
  39  */
  40 #ifdef HED_CONFIG_LFS
  41 typedef int64_t hed_off_t;
  42 typedef uint64_t hed_uoff_t;
  43 #else
  44 typedef signed long int hed_off_t;
  45 typedef unsigned long int hed_uoff_t;
  46 #endif
  47
  48 /*******************************************************************
  49  * DOUBLY LINKED LIST
  50  */
  51
  52 struct hed_list_head {
  53         struct hed_list_head *next, *prev;
  54 };
  55
  56 /*******************************************************************
  57  * FILE TREE
  58  */
  59
  60 struct hed_tree_node {
  61         /* Used for the linked list */
  62         struct hed_list_head link;
  63         /* Can be the null node for the root. */
  64         struct hed_tree_node *up;
  65         /* Both can be the null node for leaves. */
  66         struct hed_tree_node *left;
  67         struct hed_tree_node *right;
  68         /* Size of the entry. (This is public.) */
  69         hed_uoff_t size;
  70         /* Size of the entry plus its children. (Private.) */
  71         hed_uoff_t cover_size;
  72 };
  73
  74 /*******************************************************************
  75  * BLOCK DATA
  76  */
  77
  78 /* This is the block data descriptor
  79  * The usage of some fields is not self-evident:
  80  *
  81  * @size        ALWAYS denotes the number of bytes which can fit
  82  *              into @data
  83  *
  84  * @data        may be embedded inside the hed_block_data object,
  85  *              detached in a dynamically allocated array,
  86  *              or unmaintained (for cached blocks with HED_CONFIG_MMAP)
  87  *
  88  * Some additional notes:
  89  * - @data is always allocated for out-of-cache objects
  90  */
  91 struct hed_block_data {
  92         size_t size;            /* size of data */
  93         void *data;
  94
  95         union {
  96                 struct hed_list_head free; /* free list */
  97                 struct {
  98                         int refcount;   /* reference count */
  99                         int flags;      /* flags (see HED_FDF_* below) */
 100                 } used;
 101         } u2;
 102 };
 103
 104 #define HED_FDF_CACHED  1       /* Allocated from cache */
 105
 106 #endif  /* LIBHED__TYPES_H */