cutil/variables.h File Reference

#include "cutil.h"
#include "oldlist.h"

Go to the source code of this file.

Classes

• union VALUE

  Holds default 'value', ie: four 'types' with ONE shared value. More...
  

• class VARIABLE

  Holds info on address, name, default value, reading & writing functions of one variable. More...
  

Defines

• #define float_variable(name, string, default)
• #define int_variable(name, string, default)

  Create a int point variable that can be read and written from a configuration file.
  

• #define string_variable(name, string, default)

  Create a string point variable that can be read and written from a configuration file.
  

Typedefs

• typedef void(*) variables_io (VARIABLE *variable, char *string)

Functions

• void add_32bit_variable (void *address, const char *string, VALUE default_value, variables_io reader, variables_io writer)

  Add a new 32bit variable to the global variable list.
  

• void add_ptr_variable (void *address, const char *string, VALUE default_value, variables_io reader, variables_io writer)

  Add a new variable to the global variable list & initalize its value.
  

• void float_read (VARIABLE *variable, char *string)

  Read a float value and save it in a variable structure.
  

• void float_write (VARIABLE *variable, char *string)

  Write a float value to string.
  

• void free_variables ()

  Free up memory used by tesseract variables.
  

• void int_read (VARIABLE *variable, char *string)

  Read an integer value and save it in a variable structure.
  

• void int_write (VARIABLE *variable, char *string)

  Write an integer value to string.
  

• void read_variables (const char *filename)

  Read a file that contains assignments for all the desired variables.
  

• int same_var_name (void *item1, void *item2)

  Return TRUE if the VARIABLE has the name string in it.
  

• void string_read (VARIABLE *variable, char *string)

  Read a string and save it in a variable structure.
  

• void string_write (VARIABLE *variable, char *string)

  Write a string to ??
  

• char * strip_line (char *string)

  Remove the name off the front of the line and strip the white space before and after the value.
  

Variables

• VALUE dummy

---

Define Documentation

#define float_variable	(	name,
		string,
		default		)

Value:

dummy.float_part = default;                              \
add_32bit_variable (&name, string, dummy, float_read, float_write)

Create a floating point variable that can be read and written from a configuration file.

Definition at line 106 of file variables.h.

Referenced by InitMicroFxVars(), and InitPicoFXVars().

#define int_variable	(	name,
		string,
		default		)

Value:

dummy.int_part = default;                              \
add_32bit_variable (&name, string, dummy, int_read, int_write)

Create a int point variable that can be read and written from a configuration file.

Definition at line 122 of file variables.h.

Referenced by init_textord_vars(), and program_variables().

#define string_variable	(	name,
		string,
		default		)

Value:

dummy.char_part = default;                    \
add_ptr_variable (&name, string, dummy, string_read, string_write)

Create a string point variable that can be read and written from a configuration file.

Definition at line 114 of file variables.h.

Referenced by InitAdaptiveClassifierVars(), InitBlobClassifierVars(), InitNormProtoVars(), InitPrototypes(), InitStopperVars(), and program_variables().

---

Typedef Documentation

typedef void(*) variables_io(VARIABLE *variable, char *string)

Definition at line 43 of file variables.h.

---

Function Documentation

void add_32bit_variable	(	void *	address,
		const char *	string,
		VALUE	default_value,
		variables_io	reader,
		variables_io	writer
	)

Add a new 32bit variable to the global variable list.

Initalize its value.

Definition at line 100 of file variables.cpp.

References VARIABLE::address, VARIABLE::default_value, VALUE::int_part, push(), VARIABLE::string, VARIABLE::type_reader, VARIABLE::type_writer, and variable_list.

                                             {
  VARIABLE *this_var;
  this_var = (VARIABLE *) malloc (sizeof (VARIABLE));

  this_var->address = address;
  this_var->string = string;
  this_var->default_value = default_value;
  this_var->type_reader = reader;
  this_var->type_writer = writer;

  *((int *) this_var->address) = default_value.int_part;
  variable_list = push (variable_list, this_var);
}

void add_ptr_variable	(	void *	address,
		const char *	string,
		VALUE	default_value,
		variables_io	reader,
		variables_io	writer
	)

Add a new variable to the global variable list & initalize its value.

Parameters:

	address	Location of Name
	string	Name of variable
	default_value	Default value
	reader	Function to read this variable (type)
	writer	Function to write this variable (type)

Returns:

none

Definition at line 76 of file variables.cpp.

References VARIABLE::address, VARIABLE::default_value, VALUE::ptr_part, push(), VARIABLE::string, VARIABLE::type_reader, VARIABLE::type_writer, and variable_list.

                                       {
  VARIABLE *this_var;
  this_var = (VARIABLE *) malloc (sizeof (VARIABLE));

  this_var->address = address;
  this_var->string = string;
  this_var->default_value = default_value;
  this_var->type_reader = reader;
  this_var->type_writer = writer;

  *((void **) this_var->address) = default_value.ptr_part;
  variable_list = push (variable_list, this_var);
}

void float_read	(	VARIABLE *	variable,
		char *	string
	)

Read a float value and save it in a variable structure.

Definition at line 122 of file variables.cpp.

References VARIABLE::address, f, strip_line(), and strtofloat().

                                                  {
  float f;

  #ifdef EMBEDDED
    // We have no sscanf with float functionality here
    *((float *) variable->address) = strtofloat(strip_line (string));
  #else
    sscanf (strip_line (string), "%f", &f);
    *((float *) variable->address) = f;
  #endif
}

void float_write	(	VARIABLE *	variable,
		char *	string
	)

Write a float value to string.

Definition at line 138 of file variables.cpp.

References VARIABLE::address, f, and VARIABLE::string.

                                                   {
  float *f;
  f = (float *) variable->address;
  sprintf (string, "%s\t%4.2f", variable->string, *f);
}

void free_variables

(

)

Free up memory used by tesseract variables.

Note:

New in v1.03

Definition at line 61 of file variables.cpp.

References destroy_nodes(), NIL, and variable_list.

Referenced by program_editdown().

                      {
  destroy_nodes(variable_list, free);
  variable_list = NIL;
}

void int_read	(	VARIABLE *	variable,
		char *	string
	)

Read an integer value and save it in a variable structure.

Definition at line 148 of file variables.cpp.

References VARIABLE::address, scan_int, and strip_line().

                                                {
  char *stripped;
  int integer;

  stripped = strip_line (string);
  /* Add the value */
  if (stripped[0] == '+') {
    scan_int(stripped, integer);
    *((int *) variable->address) += integer;
  }
  else if (stripped[0] == '|') {
    scan_int(stripped, integer);
    *((int *) variable->address) = integer | *((int *) variable->address);
  }                              /* Subtract the value */
  else if (stripped[0] == '_') {
    scan_int(stripped, integer);
    *((int *) variable->address) = (~integer) &
      *((int *) variable->address);
  }
  else {
                                 /* Set the value */
    if (stripped[1] == 'x') {
      sscanf (&stripped[2], "%x", &integer);
    }
    else {
      sscanf (stripped, "%d", &integer);
    }
    *((int *) variable->address) = integer;
  }
}

void int_write	(	VARIABLE *	variable,
		char *	string
	)

Write an integer value to string.

Definition at line 183 of file variables.cpp.

References VARIABLE::address, and VARIABLE::string.

                                                 { 
  sprintf (string, "%s\t%d", variable->string, *((int *) variable->address));
}

void read_variables

(

const char *

filename

)

Read a file that contains assignments for all the desired variables.

Parameters:

filename

Name of file to read

Returns:

none

This type of file can be written using the function write_vars.

Note:

Exception: will exit(1) if any variable in filename not recognized

Definition at line 197 of file variables.cpp.

References cprintf(), demodir, first, iterate, NULL, read_list(), same_var_name(), search(), VARIABLE::type_reader, and variable_list.

Referenced by program_editup().

                                          { 
  int x = 0;
  char *this_string;
  LIST var_strings;
  char name[1024];
  FILE *fp;
  VARIABLE *this_var;
  /* Read the strings */
  if (filename == NULL || filename[0] == '\0')
    return;

  strcpy(name, demodir);
  strcat (name, "tessdata/tessconfigs/");
  strcat(name, filename);
  if ((fp = fopen (name, "r")) == NULL)
    strcpy(name, filename);
  else
    fclose(fp);
  var_strings = read_list (name);
  iterate(var_strings) {
    /* Get the name string */
    this_string = (char *) first (var_strings);
    if (this_string[0] != '#') {
      for (x = 0;
        x < strlen (this_string) && this_string[x] != ' '
        && this_string[x] != '\t'; x++);
      this_string[x] = '\0';
      /* Find variable record */
      this_var = (VARIABLE *) first (search (variable_list, this_string,
        same_var_name));
      if (this_var == 0) {
#ifndef TEXT_VERBOSE
        cprintf ("error: Could not find variable '%s'\n", this_string);
        exit (1);                //?err_exit ();
#else
        cprintf ("error: Could not find variable '%s', skipping\n", this_string);
      continue;
#endif
      }
      /* Read the value */
      this_string[x] = '\t';
      (*(this_var->type_reader)) (this_var, this_string);
    }
  }
}

int same_var_name	(	void *	item1,
		void *	item2
	)

Return TRUE if the VARIABLE has the name string in it.

Definition at line 247 of file variables.cpp.

References FALSE, VARIABLE::string, and TRUE.

Referenced by read_variables().

                               {  //char     *string)
  VARIABLE *variable;
  char *string;

  variable = (VARIABLE *) item1;
  string = (char *) item2;

  if (strcmp (variable->string, string))
    return (FALSE);
  else
    return (TRUE);
}

void string_read	(	VARIABLE *	variable,
		char *	string
	)

Read a string and save it in a variable structure.

Definition at line 265 of file variables.cpp.

References VARIABLE::address, strip_line(), and strsave.

                                                   { 
  char *value;

  value = strsave (strip_line (string));
  *((char **) variable->address) = value;
}

void string_write	(	VARIABLE *	variable,
		char *	string
	)

Write a string to ??

Definition at line 276 of file variables.cpp.

References VARIABLE::address, and VARIABLE::string.

                                                    { 
  sprintf (string, "%s\t%s", variable->string,
    *((char **) variable->address));
}

char* strip_line

(

char *

string

)

Remove the name off the front of the line and strip the white space before and after the value.

Definition at line 286 of file variables.cpp.

Referenced by float_read(), int_read(), and string_read().

                               { 
  int x;
  int y;

  /* Skip over name */
  for (x = 0;
    x < strlen (string) && string[x] != '\t' && string[x] != ' '; x++);
  /* Skip over whitespace */
  while (x < strlen (string) && (string[x] == '\t' || string[x] == ' '))
    x++;
  /* Strip trailing whitespace */
  for (y = strlen (string);
    y >= 0 && (string[y - 1] == '\t' || string[y - 1] == ' '); y--)
  string[y] = '\0';
  /* Return result */
  return (&string[x]);
}

---

Variable Documentation

VALUE dummy

Needed for macros

Definition at line 38 of file variables.cpp.

Referenced by classify_word_pass2(), InitAdaptiveClassifierVars(), InitBlobClassifierVars(), InitMicroFxVars(), InitNormProtoVars(), InitPicoFXVars(), InitStopperVars(), program_variables(), re_segment_word(), read_pd_file(), resegment_box(), and scale_image().

---