/usr/include/code_saturne/cs_map.h is in code-saturne-include 3.2.1-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 | #ifndef __CS_MAP_H__
#define __CS_MAP_H__
/*============================================================================
* Map helper structures
*============================================================================*/
/*
This file is part of Code_Saturne, a general-purpose CFD tool.
Copyright (C) 1998-2013 EDF S.A.
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., 51 Franklin
Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
* Local headers
*----------------------------------------------------------------------------*/
#include "cs_base.h"
/*----------------------------------------------------------------------------*/
BEGIN_C_DECLS
/*============================================================================
* Macro definitions
*============================================================================*/
/*============================================================================
* Type definitions
*============================================================================*/
typedef struct _cs_map_name_to_id_t cs_map_name_to_id_t;
/*============================================================================
* Global variables
*============================================================================*/
/*=============================================================================
* Public function prototypes for Fortran API
*============================================================================*/
/*=============================================================================
* Public function prototypes
*============================================================================*/
/*----------------------------------------------------------------------------
* Create empty name to id map.
*
* returns:
* pointer to newly initialized map structure.
*----------------------------------------------------------------------------*/
cs_map_name_to_id_t *
cs_map_name_to_id_create(void);
/*----------------------------------------------------------------------------
* Destroy name to id map structure.
*
* parameters:
* m <-> pointer to map structure.
*----------------------------------------------------------------------------*/
void
cs_map_name_to_id_destroy(cs_map_name_to_id_t **m);
/*----------------------------------------------------------------------------
* Find id matching a key, inserting key if not already present.
*
* parameters:
* m <-> pointer to map structure
* key <-- character string (key)
*
* returns:
* id matching key (already present or newly inserted)
*----------------------------------------------------------------------------*/
int
cs_map_name_to_id(cs_map_name_to_id_t *m,
const char *key);
/*----------------------------------------------------------------------------
* Return id matching a key, or -1 if not present.
*
*
* parameters:
* m <-- pointer to map structure
* key <-- character string (key)
*
* returns:
* id matching key, or -1.
*----------------------------------------------------------------------------*/
int
cs_map_name_to_id_try(const cs_map_name_to_id_t *m,
const char *key);
/*----------------------------------------------------------------------------
* Return a key name in a map matching a given id.
*
* parameters:
* m <-- pointer to map structure.
* id <-- key id
*
* returns:
* pointer to key.
*----------------------------------------------------------------------------*/
const char *
cs_map_name_to_id_reverse(const cs_map_name_to_id_t *m,
size_t id);
/*----------------------------------------------------------------------------
* Return the size of a map.
*
* parameters:
* m <-- pointer to map structure.
*
* returns:
* number of entries in map.
*----------------------------------------------------------------------------*/
size_t
cs_map_name_to_id_size(const cs_map_name_to_id_t *m);
/*----------------------------------------------------------------------------
* Return key in a map for a given index position.
*
* parameters:
* m <-- pointer to map structure.
* index <-- key index
*
* returns:
* pointer to key.
*----------------------------------------------------------------------------*/
const char *
cs_map_name_to_id_key(const cs_map_name_to_id_t *m,
size_t index);
/*----------------------------------------------------------------------------*/
END_C_DECLS
#endif /* __CS_MAP_H__ */
|