/usr/include/cbf/cbf_file.h is in libcbf-dev 0.9.2.2-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 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 | /**********************************************************************
* cbf_file.h *
* *
* Version 0.7.6 14 July 2006 *
* *
* Paul Ellis and *
* Herbert J. Bernstein (yaya@bernstein-plus-sons.com) *
* *
* (C) Copyright 2006 Herbert J. Bernstein *
* *
**********************************************************************/
/**********************************************************************
* *
* YOU MAY REDISTRIBUTE THE CBFLIB PACKAGE UNDER THE TERMS OF THE GPL *
* *
* ALTERNATIVELY YOU MAY REDISTRIBUTE THE CBFLIB API UNDER THE TERMS *
* OF THE LGPL *
* *
**********************************************************************/
/*************************** GPL NOTICES ******************************
* *
* 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., 59 Temple Place, Suite 330, Boston, MA *
* 02111-1307 USA *
* *
**********************************************************************/
/************************* LGPL NOTICES *******************************
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library 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 *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this library; if not, write to the Free *
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
* MA 02110-1301 USA *
* *
**********************************************************************/
/**********************************************************************
* *
* Stanford University Notices *
* for the CBFlib software package that incorporates SLAC software *
* on which copyright is disclaimed *
* *
* This software *
* ------------- *
* The term Ôthis softwareÕ, as used in these Notices, refers to *
* those portions of the software package CBFlib that were created by *
* employees of the Stanford Linear Accelerator Center, Stanford *
* University. *
* *
* Stanford disclaimer of copyright *
* -------------------------------- *
* Stanford University, owner of the copyright, hereby disclaims its *
* copyright and all other rights in this software. Hence, anyone *
* may freely use it for any purpose without restriction. *
* *
* Acknowledgement of sponsorship *
* ------------------------------ *
* This software was produced by the Stanford Linear Accelerator *
* Center, Stanford University, under Contract DE-AC03-76SFO0515 with *
* the Department of Energy. *
* *
* Government disclaimer of liability *
* ---------------------------------- *
* Neither the United States nor the United States Department of *
* Energy, nor any of their employees, makes any warranty, express or *
* implied, or assumes any legal liability or responsibility for the *
* accuracy, completeness, or usefulness of any data, apparatus, *
* product, or process disclosed, or represents that its use would *
* not infringe privately owned rights. *
* *
* Stanford disclaimer of liability *
* -------------------------------- *
* Stanford University makes no representations or warranties, *
* express or implied, nor assumes any liability for the use of this *
* software. *
* *
* Maintenance of notices *
* ---------------------- *
* In the interest of clarity regarding the origin and status of this *
* software, this and all the preceding Stanford University notices *
* are to remain affixed to any copy or derivative of this software *
* made or distributed by the recipient and are to be affixed to any *
* copy of software made or distributed by the recipient that *
* contains a copy or derivative of this software. *
* *
* Based on SLAC Software Notices, Set 4 *
* OTT.002a, 2004 FEB 03 *
**********************************************************************/
/**********************************************************************
* NOTICE *
* Creative endeavors depend on the lively exchange of ideas. There *
* are laws and customs which establish rights and responsibilities *
* for authors and the users of what authors create. This notice *
* is not intended to prevent you from using the software and *
* documents in this package, but to ensure that there are no *
* misunderstandings about terms and conditions of such use. *
* *
* Please read the following notice carefully. If you do not *
* understand any portion of this notice, please seek appropriate *
* professional legal advice before making use of the software and *
* documents included in this software package. In addition to *
* whatever other steps you may be obliged to take to respect the *
* intellectual property rights of the various parties involved, if *
* you do make use of the software and documents in this package, *
* please give credit where credit is due by citing this package, *
* its authors and the URL or other source from which you obtained *
* it, or equivalent primary references in the literature with the *
* same authors. *
* *
* Some of the software and documents included within this software *
* package are the intellectual property of various parties, and *
* placement in this package does not in any way imply that any *
* such rights have in any way been waived or diminished. *
* *
* With respect to any software or documents for which a copyright *
* exists, ALL RIGHTS ARE RESERVED TO THE OWNERS OF SUCH COPYRIGHT. *
* *
* Even though the authors of the various documents and software *
* found here have made a good faith effort to ensure that the *
* documents are correct and that the software performs according *
* to its documentation, and we would greatly appreciate hearing of *
* any problems you may encounter, the programs and documents any *
* files created by the programs are provided **AS IS** without any *
* warranty as to correctness, merchantability or fitness for any *
* particular or general use. *
* *
* THE RESPONSIBILITY FOR ANY ADVERSE CONSEQUENCES FROM THE USE OF *
* PROGRAMS OR DOCUMENTS OR ANY FILE OR FILES CREATED BY USE OF THE *
* PROGRAMS OR DOCUMENTS LIES SOLELY WITH THE USERS OF THE PROGRAMS *
* OR DOCUMENTS OR FILE OR FILES AND NOT WITH AUTHORS OF THE *
* PROGRAMS OR DOCUMENTS. *
**********************************************************************/
/**********************************************************************
* *
* The IUCr Policy *
* for the Protection and the Promotion of the STAR File and *
* CIF Standards for Exchanging and Archiving Electronic Data *
* *
* Overview *
* *
* The Crystallographic Information File (CIF)[1] is a standard for *
* information interchange promulgated by the International Union of *
* Crystallography (IUCr). CIF (Hall, Allen & Brown, 1991) is the *
* recommended method for submitting publications to Acta *
* Crystallographica Section C and reports of crystal structure *
* determinations to other sections of Acta Crystallographica *
* and many other journals. The syntax of a CIF is a subset of the *
* more general STAR File[2] format. The CIF and STAR File approaches *
* are used increasingly in the structural sciences for data exchange *
* and archiving, and are having a significant influence on these *
* activities in other fields. *
* *
* Statement of intent *
* *
* The IUCr's interest in the STAR File is as a general data *
* interchange standard for science, and its interest in the CIF, *
* a conformant derivative of the STAR File, is as a concise data *
* exchange and archival standard for crystallography and structural *
* science. *
* *
* Protection of the standards *
* *
* To protect the STAR File and the CIF as standards for *
* interchanging and archiving electronic data, the IUCr, on behalf *
* of the scientific community, *
* *
* * holds the copyrights on the standards themselves, *
* *
* * owns the associated trademarks and service marks, and *
* *
* * holds a patent on the STAR File. *
* *
* These intellectual property rights relate solely to the *
* interchange formats, not to the data contained therein, nor to *
* the software used in the generation, access or manipulation of *
* the data. *
* *
* Promotion of the standards *
* *
* The sole requirement that the IUCr, in its protective role, *
* imposes on software purporting to process STAR File or CIF data *
* is that the following conditions be met prior to sale or *
* distribution. *
* *
* * Software claiming to read files written to either the STAR *
* File or the CIF standard must be able to extract the pertinent *
* data from a file conformant to the STAR File syntax, or the CIF *
* syntax, respectively. *
* *
* * Software claiming to write files in either the STAR File, or *
* the CIF, standard must produce files that are conformant to the *
* STAR File syntax, or the CIF syntax, respectively. *
* *
* * Software claiming to read definitions from a specific data *
* dictionary approved by the IUCr must be able to extract any *
* pertinent definition which is conformant to the dictionary *
* definition language (DDL)[3] associated with that dictionary. *
* *
* The IUCr, through its Committee on CIF Standards, will assist *
* any developer to verify that software meets these conformance *
* conditions. *
* *
* Glossary of terms *
* *
* [1] CIF: is a data file conformant to the file syntax defined *
* at http://www.iucr.org/iucr-top/cif/spec/index.html *
* *
* [2] STAR File: is a data file conformant to the file syntax *
* defined at http://www.iucr.org/iucr-top/cif/spec/star/index.html *
* *
* [3] DDL: is a language used in a data dictionary to define data *
* items in terms of "attributes". Dictionaries currently approved *
* by the IUCr, and the DDL versions used to construct these *
* dictionaries, are listed at *
* http://www.iucr.org/iucr-top/cif/spec/ddl/index.html *
* *
* Last modified: 30 September 2000 *
* *
* IUCr Policy Copyright (C) 2000 International Union of *
* Crystallography *
**********************************************************************/
#ifndef CBF_FILE_H
#define CBF_FILE_H
#ifdef __cplusplus
extern "C" {
#endif
#include <stdio.h>
#include "global.h"
#include "md5.h"
/* File structure */
typedef struct
{
FILE *stream; /* File pointer */
FILE *logfile; /* NULL or an active stream for error logging */
int errors; /* logged error messages */
int warnings; /* logged warnings */
unsigned int connections; /* Number of pointers to this structure */
int temporary; /* Flag for temporary file (memres) */
int bits [2]; /* Buffer for bitwise reads and writes */
char *characters; /* Buffer for character writes */
char *characters_base; /* Buffer for character memres file */
size_t characters_size; /* Size of the buffer for character writes*/
size_t characters_used; /* Characters in the character buffer */
int last_read; /* The last character read */
unsigned int line; /* Current line */
unsigned int column; /* Current column */
unsigned int columnlimit; /* Ascii line column limit (80 or 2048) */
char *buffer; /* Buffer */
size_t buffer_size; /* Size of the buffer */
size_t buffer_used; /* Number in use */
int read_headers; /* message digest control (read) */
int write_headers; /* message digest and header type (write) */
int write_encoding; /* encoding and line terminations (write) */
MD5_CTX *digest; /* message digest context */
}
cbf_file;
/* Create and initialise a file */
int cbf_make_file (cbf_file **file, FILE *stream);
/* Create and initialise a wide file */
int cbf_make_widefile (cbf_file **file, FILE *stream);
/* Free a file */
int cbf_free_file (cbf_file **file);
/* Add a file connection */
int cbf_add_fileconnection (cbf_file **file, FILE *stream);
/* Remove a connection */
int cbf_delete_fileconnection (cbf_file **file);
/* Count the connections */
int cbf_file_connections (cbf_file *file);
/* Set the size of an input/output buffer */
int cbf_set_io_buffersize (cbf_file *file, size_t size);
/* Set the size of an output buffer */
int cbf_set_buffersize (cbf_file *file, size_t size);
/* Empty the buffer */
int cbf_reset_buffer (cbf_file *file);
/* Add a character to the buffer */
int cbf_save_character (cbf_file *file, int c);
/* Add a character to the buffer, trimming trailing spaces */
int cbf_save_character_trim (cbf_file *file, int c);
/* Add a character to the buffer at a given position */
int cbf_save_character_at (cbf_file *file, int c, size_t position);
/* Retrieve the buffer */
int cbf_get_buffer (cbf_file *file, const char **buffer,
size_t *buffer_size);
/* Get the file coordinates */
int cbf_get_filecoordinates (cbf_file *file, unsigned int *line,
unsigned int *column);
/* Set the file coordinates */
int cbf_set_filecoordinates (cbf_file *file, unsigned int line,
unsigned int column);
/* Read the next bit */
int cbf_get_bit (cbf_file *file);
/* Read the next bits (signed) */
int cbf_get_bits (cbf_file *file, int *bitslist, int bitcount);
/* Write bits */
int cbf_put_bits (cbf_file *file, int *bitslist, int bitcount);
/* Read an integer as a series of bits */
int cbf_get_integer (cbf_file *file, int *val, int valsign, int bitcount);
/* Write an integer as a series of bits */
int cbf_put_integer (cbf_file *file, int val, int valsign, int bitcount);
/* Initialize a message digest */
int cbf_start_digest (cbf_file *file);
/* Get the message digest */
int cbf_end_digest (cbf_file *file, char *digest);
/* Discard any bits in the buffers */
int cbf_reset_bits (cbf_file *file);
/* Discard any bits in the input buffers */
int cbf_reset_in_bits (cbf_file *file);
/* Discard any characters in the character buffers */
int cbf_reset_characters (cbf_file *file);
/* Flush any remaining bits (write) */
int cbf_flush_bits (cbf_file *file);
/* Flush the character buffer (write) */
int cbf_flush_characters (cbf_file *file);
/* Set output buffer size */
int cbf_set_output_buffersize (cbf_file *file, size_t size);
/* Get the next character */
int cbf_get_character (cbf_file *file);
/* Read the next character (convert end-of-line and update line and column) */
int cbf_read_character (cbf_file *file);
/* Put the next character */
int cbf_put_character (cbf_file *file, int c);
/* Write the next character (convert end-of-line and update line and column) */
int cbf_write_character (cbf_file *file, int c);
/* Put a string */
int cbf_put_string (cbf_file *file, const char *string);
/* Write a string (convert end-of-line and update line and column) */
int cbf_write_string (cbf_file *file, const char *string);
/* Read a (CR/LF)-terminated line into the buffer */
int cbf_read_line (cbf_file *file, const char **line);
/* Read nelem characters into the buffer */
int cbf_get_block (cbf_file *file, size_t nelem);
/* Write nelem characters from the buffer */
int cbf_put_block (cbf_file *file, size_t nelem);
/* Copy characters between files */
int cbf_copy_file (cbf_file *destination, cbf_file *source, size_t nelem);
/* Get the file position */
int cbf_get_fileposition (cbf_file *file, long int *position);
/* Set the file position */
int cbf_set_fileposition (cbf_file *file, long int position, int whence);
#ifdef __cplusplus
}
#endif
#endif /* CBF_FILE_H */
|