fstr_ctrl_util.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (c) 2019 FrontISTR Commons
 * This software is released under the MIT License, see LICENSE.txt
 *****************************************************************************/
#ifndef fstr_ctrl_utilH
#define fstr_ctrl_utilH
 
#include <assert.h>
#include <stdarg.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <ctype.h>
#include <hecmw_config.h>
 
#ifndef HECMW_SERIAL
#include <hecmw_comm.h>
#endif
 
#define FSTR_CTRL_RCODE_PARAM_SUCCESS 0
#define FSTR_CTRL_RCODE_PARAM_ERROR -1
#define FSTR_CTRL_RCODE_PARAM_TYPE_ERROR -2
#define FSTR_CTRL_RCODE_PARAM_RANGE_ERROR -3
#define FSTR_CTRL_RCODE_PARAM_NOTHING 1
#define FSTR_CTRL_RCODE_PARAM_VALUE_NOTHING 2
 
#define FSTR_CTRL_RCODE_DATA_SUCCESS 0
#define FSTR_CTRL_RCODE_DATA_ERROR -1
#define FSTR_CTRL_RCODE_DATA_TYPE_ERROR -2
#define FSTR_CTRL_RCODE_DATA_RANGE_ERROR -3
#define FSTR_CTRL_RCODE_DATA_NOTHING 1
#define FSTR_CTRL_RCODE_DATA_LINE_NOTHING 2
 
typedef struct st_ctrl_rec {
  int line_no;
  char* line;
} ctrl_rec;
 
typedef struct st_fstr_ctrl_data {
  ctrl_rec* rec;
  int rec_n;
  int* header_pos;
  int header_n;
  int* data_line_n;
  int current_header_index;
} fstr_ctrl_data;
 
/* ctrl list for fortran interface  */
#define ctrl_list_size 20
#ifdef fstr_ctrl_util_MAIN
fstr_ctrl_data* ctrl_list[ctrl_list_size];
#else
extern fstr_ctrl_data* ctrl_list[ctrl_list_size];
#endif
 
/* =================================================================================
 */
void c_fstr_ctrl_get_err_msg(char* buff, size_t buff_size);
 
/* =================================================================================
 */
fstr_ctrl_data* c_fstr_ctrl_open(const char* filename);
 
/* =================================================================================
 */
int c_fstr_ctrl_get_rec_number(fstr_ctrl_data* ctrl);
 
/* =================================================================================
 */
int c_fstr_ctrl_get_line(fstr_ctrl_data* ctrl, int rec_no, char* buff,
                         size_t buff_size);
 
/* =================================================================================
 */
int c_fstr_ctrl_seek_header(fstr_ctrl_data* ctrl, const char* header_name);
 
/* =================================================================================
 */
int c_fstr_ctrl_seek_next_header(fstr_ctrl_data* ctrl);
 
/* =================================================================================
 */
int c_fstr_ctrl_get_current_header_name(fstr_ctrl_data* ctrl,
                                        char* header_name);
 
/* =================================================================================
 */
int c_fstr_ctrl_get_current_header_line_no(fstr_ctrl_data* ctrl);
 
/* =================================================================================
 */
int c_fstr_ctrl_get_current_header_pos(fstr_ctrl_data* ctrl);
 
/* =================================================================================
 */
int c_fstr_ctrl_get_param(fstr_ctrl_data* ctrl, const char* param_name,
                          const char* value_list, char type, void* val);
 
/* =================================================================================
 */
int c_fstr_ctrl_get_param_ex(fstr_ctrl_data* ctrl, const char* param_name,
                             const char* value_list, int necessity, char type,
                             void* val);
 
/* =================================================================================
 */
int c_fstr_ctrl_get_data_line_n(fstr_ctrl_data* ctrl);
 
/* =================================================================================
 */
/* JP-0 */
 
int c_fstr_ctrl_copy_data_line(fstr_ctrl_data* ctrl, int line_no,
                               char* data_line, size_t data_line_len);
 
/* =================================================================================
 */
/* JP-1 */
 
int c_fstr_ctrl_get_data_n_in_line(fstr_ctrl_data* ctrl, int line_no,
                                   const char* delim);
 
/* =================================================================================
 */
int c_fstr_ctrl_get_data_error_pos(void);
 
int c_fstr_ctrl_get_data_error_line(void);
 
/* =================================================================================
 */
/* JP-2 */
 
int c_fstr_ctrl_get_data(fstr_ctrl_data* ctrl, int line_no, const char* format,
                         ...);
int c_fstr_ctrl_get_data_v(fstr_ctrl_data* ctrl, int line_no,
                           const char* format, va_list va);
int c_fstr_ctrl_get_data_ex(fstr_ctrl_data* ctrl, int line_no,
                            const char* format, ...);
 
int c_fstr_ctrl_get_data_array(fstr_ctrl_data* ctrl, const char* format, ...);
int c_fstr_ctrl_get_data_array_v(fstr_ctrl_data* ctrl, const char* format,
                                 va_list va);
int c_fstr_ctrl_get_data_array_ex(fstr_ctrl_data* ctrl, const char* format,
                                  ...);
 
/* =================================================================================
 */
int c_fstr_ctrl_close(fstr_ctrl_data* ctrl);
 
#endif