100 lines
3.5 KiB
C
100 lines
3.5 KiB
C
/* LIBPIKA - The PIKA Library
|
|
* Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
|
|
*
|
|
* pikaeevl.h
|
|
* Copyright (C) 2008-2009 Fredrik Alstromer <roe@excu.se>
|
|
* Copyright (C) 2008-2009 Martin Nordholts <martinn@svn.gnome.org>
|
|
*
|
|
* 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 3 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, see
|
|
* <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef __PIKA_EEVL_H__
|
|
#define __PIKA_EEVL_H__
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
|
|
/**
|
|
* PikaEevlQuantity:
|
|
* @value: In reference units.
|
|
* @dimension: in has a dimension of 1, in^2 has a dimension of 2 etc
|
|
*/
|
|
typedef struct
|
|
{
|
|
gdouble value;
|
|
gint dimension;
|
|
} PikaEevlQuantity;
|
|
|
|
|
|
/**
|
|
* PikaEevlUnitResolverProc:
|
|
* @identifier: Identifier of unit to resolve or %NULL if default unit
|
|
* should be resolved.
|
|
* @factor: Units per reference unit. For example, in PIKA the
|
|
* reference unit is inches so resolving "mm" should
|
|
* return 25.4 since there are 25.4 millimeters per inch.
|
|
* @offset: Offset to apply after scaling the value according to @factor.
|
|
* @data: Data given to pika_eevl_evaluate().
|
|
*
|
|
* Returns: If the unit was successfully resolved or not.
|
|
*
|
|
*/
|
|
typedef gboolean (* PikaEevlUnitResolverProc) (const gchar *identifier,
|
|
PikaEevlQuantity *factor,
|
|
gdouble *offset,
|
|
gpointer data);
|
|
|
|
|
|
/**
|
|
* PikaEevlOptions:
|
|
* @unit_resolver_proc: Unit resolver callback.
|
|
* @data: Data passed to unit resolver.
|
|
* @ratio_expressions: Allow ratio expressions
|
|
* @ratio_invert: Invert ratios
|
|
* @ratio_quantity: Quantity to multiply ratios by
|
|
*/
|
|
typedef struct
|
|
{
|
|
PikaEevlUnitResolverProc unit_resolver_proc;
|
|
gpointer data;
|
|
|
|
gboolean ratio_expressions;
|
|
gboolean ratio_invert;
|
|
PikaEevlQuantity ratio_quantity;
|
|
} PikaEevlOptions;
|
|
|
|
#define PIKA_EEVL_OPTIONS_INIT \
|
|
((const PikaEevlOptions) \
|
|
{ \
|
|
.unit_resolver_proc = NULL, \
|
|
.data = NULL, \
|
|
\
|
|
.ratio_expressions = FALSE, \
|
|
.ratio_invert = FALSE, \
|
|
.ratio_quantity = {0.0, 0} \
|
|
})
|
|
|
|
|
|
gboolean pika_eevl_evaluate (const gchar *string,
|
|
const PikaEevlOptions *options,
|
|
PikaEevlQuantity *result,
|
|
const gchar **error_pos,
|
|
GError **error);
|
|
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __PIKA_EEVL_H__ */
|
