unity.h

Go to the documentation of this file.

/* GENERATED by Makefile.in */
/* DO NOT EDIT */
#ifndef UNITY_H_LOADED
#define UNITY_H_LOADED 1
/* From known-syntaxes.h */
#ifndef KNOWN_SYNTAXES_H
#define KNOWN_SYNTAXES_H 1

typedef enum {
    UNITY_SYNTAX_FITS,
    UNITY_SYNTAX_OGIP,
    UNITY_SYNTAX_CDS,
    UNITY_SYNTAX_VOUNITS,
    UNITY_SYNTAX_LATEX,
    UNITY_SYNTAX_DEBUG,
    UNITY_SYNTAX_NONE,
} UnitySyntax;

#if 0
/* XXX DELETE */
#ifdef UNITY_INTERNAL
/* Number of syntaxes */
#define U_NSYNTAXES 6
#endif
#endif

#endif /* KNOWN_SYNTAXES_H */

/* From function-definitions.h ... */
#ifndef FUNCTION_DEFINITIONS_H
#define FUNCTION_DEFINITIONS_H 1


/* The functions exported by this module are the only ones which need
 * access to the data structures dumped into this file, which are
 * potentially subject to change.  The implementation of this header
 * file is generated by ../grammar/ParseFunctions.java, using the
 * function-definitions.c.template file in that directory.
 *
 * The structure elements with leading underscores are intended to be internal to
 * this function-definition.c module.
 */

struct function_definition {
    const char* description;
    const char* latex_form; 
};
typedef struct function_definition FunctionDef;

const FunctionDef* unity_get_functiondef_from_string(const char* abbrev, UnitySyntax syntax);
const char* unity_get_function_abbreviation(const FunctionDef* def, UnitySyntax syntax);

#endif /* FUNCTION_DEFINITIONS_H */
/* ...end function-definitions.h */

/* From unit-definitions.h ... */
#ifndef UNIT_DEFINITIONS_H
#define UNIT_DEFINITIONS_H 1


/* The functions exported by this module are the only ones which need
 * access to the data structures dumped into this file, which are
 * potentially subject to change.  The implementation of this header
 * file is generated by ../grammar/ParseUnits.java, using the
 * unit-definitions.c.template file in that directory.
 *
 * The structure elements with leading underscores are intended to be internal to
 * this unit-definition.c module.
*/

typedef struct {
    const char* uri;            /* the name for this unit, as a URI */
    int _idx;                   /* the internal index for this unit, in the list of unit_definition entries */
    const char* name; /* the name of the unit, such as 'Metre' -- not the abbreviation 'm' */
    const char* type; /* type such as 'length', as a URI */
    const char* dimension; /* the dimensions of this unit, as a string, eg "M L-2" */
    const char* description; /* for example 'Hz = s-1', NULL if no notes present */
    const char* latex_form; /* an abbrev suitable for LaTeX, if different from a preferred syntax */
} UnitDef;

//typedef struct unit_definition UnitDef;

#if UNITY_INTERNAL
/* A unit_representation indicates how a particular unit may be used in a particular syntax. */
struct unit_representation {
    const char* symbol;         /* a symbol for this unit, in one syntax */
    int _unit_index;            /* the index in the array of unit_definition entries */
    int si_prefixes_p;          /* true if this unit may be given SI prefixes */
    int binary_prefixes_p;      /* true if this unit may be given binary prefixes */
    int is_deprecated_p;        /* true if this unit is deprecated */
    int is_preferred_p;         /* true if this unit is the preferred unit amongst some alternatives */
};
typedef struct unit_representation UnitRep;
UnitRep* u_get_unit_representation(const UnitDef*, UnitySyntax syntax);
UnitRep* u_get_unit_representation_any(const UnitDef*);
#endif

const UnitDef* unity_get_unitdef_from_string(const char* abbrev, UnitySyntax syntax);
const char* unity_get_syntax_name(UnitySyntax syntax);
const char* unity_get_unit_uri(const UnitDef*);
const char* unity_get_unit_name(const UnitDef*);
const char* unity_get_unit_type(const UnitDef*);
const char* unity_get_unit_dimension(const UnitDef*);
const char* unity_get_unit_description(const UnitDef*);
const char* unity_get_unit_latex_form(const UnitDef*);
#endif /* UNIT_DEFINITIONS_H */
/* ...end unit-definitions.h */

/* From unitylib.h ... */
#ifndef UNITYLIB_H_LOADED
#define UNITYLIB_H_LOADED 1

typedef struct {
    float log_factor;
    const struct unit_struct* unit_sequence;

    /* a sorted version of the unit_sequence */
    struct unit_struct** sorted_unit_sequence;
    int nunits;
} UnitExpression;

typedef struct {
    const struct function_definition* definition;
    const char* name;
    //const struct unit_struct* operand;
    UnitExpression operand;
} FunctionApplication;

typedef struct {
    int prefix_power;           /* -24 to +24 */
    char base10_p;
    const UnitDef* base_unit_def;
    char* base_unit_string;     /* eg Hz or aangstrom */
} SimpleUnit;

typedef enum {
    simple_unit_type,
    function_application_type
} UnitTypes;

struct unit_struct {
    float power;
    UnitTypes type;
    union {
        SimpleUnit u;
        FunctionApplication f;
    };
    struct unit_struct *next;

    char is_quoted_unit;
};


typedef struct unit_struct Unit;

const UnitExpression* unity_parse_string(const char* unit_string, const UnitySyntax syntax);

/* The function unity_parse_error is declared (and documented) here,
   and defined in lex.lex */
const char* unity_parse_error(void);

const char** unity_parser_names(void);

UnitySyntax unity_identify_parser(const char* parser_name);
const char* unity_parser_name(const UnitySyntax parser_id);
void unity_free_expression(const UnitExpression* u);
const char* unity_version_string();
int unity_version_number();

/* Selecting units (convenience functions, since the UnitExpression struct is open */
const Unit* unity_get_unit_by_index(const UnitExpression*, int i);
const UnitDef* unity_get_unitdef_from_unit(const Unit*);
const FunctionDef* unity_get_functiondef_from_unit(const Unit*);

/* Checking units */
#define UNITY_CHECK_RECOGNISED 1

#define UNITY_CHECK_RECOMMENDED 2

#define UNITY_CHECK_CONSTRAINTS 4

#define UNITY_CHECK_ALL UNITY_CHECK_RECOGNISED | UNITY_CHECK_RECOMMENDED | UNITY_CHECK_CONSTRAINTS
int unity_check_unit(const Unit* u, const UnitySyntax syntax, const int flags);
int unity_check_expression(const UnitExpression* ue, const UnitySyntax syntax, const int flags);
int unity_equal_unit_p(const Unit*, const Unit*);
int unity_equal_expression_p(const UnitExpression*, const UnitExpression*);

#ifdef UNITY_INTERNAL
/* Internal functions */
Unit* u_new_unit(const char* unitString, const float power, const UnitySyntax syntax);
Unit* u_quoted_unit(const char* pfx, const char* unitString,
                    const float power, UnitySyntax syntax);
Unit* u_power_of_unit(Unit* u0, const float power);
Unit* u_function_application(const char* functionName,
                             const Unit* unit_sequence,
                             const UnitySyntax syntax);
Unit* u_unit_append(Unit* u1, const Unit* u2);
void u_receive_result(float, const Unit* unit_sequence);
int u_prefix_to_power(const char pfx);
Unit* u_divide_units(Unit* num, Unit* den);
Unit* u_unit_reciprocal(Unit* u);
void u_free_unit(const Unit* u);
Unit** u_get_sorted_unit_sequence(UnitExpression*, int*);
#endif

#endif
/* ...end unitylib.h */

/* From writers.h ... */
#ifndef WRITERS_H_LOADED
#define WRITERS_H_LOADED 1

#include <stdio.h>

#ifdef UNITY_INTERNAL
typedef struct {
    int nwritten;
    int len;
    char* buf;
} Buf;
typedef Buf* (*writef_ptr) (Buf*, const UnitExpression*);
#endif

char* unity_write_formatted(char* buf, int buflen, const UnitExpression*, UnitySyntax);
const char** unity_formatter_names(void);

#endif
/* ...end writers.h */
#endif