src/enums.cpp

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * enums.cpp: various enumerated types + enum -> str helpers
   4  *
   5  * Copyright 2008 Novell, Inc. (http://www.novell.com)
   6  *
   7  * See the LICENSE file included with the distribution for details.
   8  *
   9  */
  10
  11 #include <config.h>
  12
  13 #include <glib.h>
  14
  15 #include "enums.h"
  16
  17 // XXX enums are contained in these headers and should be moved to
  18 // enums.h
  19 #include "brush.h"
  20 #include "clock.h"
  21 #include "stylus.h"
  22
  23 static GHashTable *enum_map = NULL;
  24
  25 #define MAP_ENUM_FULL(n,v) { (n), (v) }
  26
  27 // use this when the name is the same as the quoted value
  28 #define MAP_NAME(n)          MAP_ENUM_FULL(#n, n)
  29
  30 // use these when the name is the same as the quoted value, but with the enum type prefixed
  31 #define MAP_ENUM(t,n)        MAP_ENUM_FULL(#n, t##n)
  32
  33 #define END_MAPPING          { NULL, 0 }
  34
  35 typedef struct {
  36         const char *name;
  37         int value;
  38 } enum_map_t;
  39
  40 static enum_map_t alignment_x_map [] = {
  41         MAP_ENUM (AlignmentX, Left),
  42         MAP_ENUM (AlignmentX, Center),
  43         MAP_ENUM (AlignmentX, Right),
  44         END_MAPPING
  45 };
  46
  47 static enum_map_t alignment_y_map [] = {
  48         MAP_ENUM (AlignmentY, Top),
  49         MAP_ENUM (AlignmentY, Center),
  50         MAP_ENUM (AlignmentY, Bottom),
  51         END_MAPPING
  52 };
  53
  54 static enum_map_t binding_mode_map [] = {
  55         MAP_ENUM (BindingMode, OneWay),
  56         MAP_ENUM (BindingMode, OneTime),
  57         MAP_ENUM (BindingMode, TwoWay),
  58         END_MAPPING
  59 };
  60
  61 static enum_map_t brush_mapping_mode_map [] = {
  62         MAP_ENUM (BrushMappingMode, Absolute),
  63         MAP_ENUM (BrushMappingMode, RelativeToBoundingBox),
  64         END_MAPPING
  65 };
  66
  67 static enum_map_t color_interpolation_mode_map [] = {
  68         MAP_ENUM (ColorInterpolationMode, ScRgbLinearInterpolation),
  69         MAP_ENUM (ColorInterpolationMode, SRgbLinearInterpolation),
  70         END_MAPPING
  71 };
  72
  73 static enum_map_t cursors_map [] = {
  74         MAP_ENUM (MouseCursor, Default),
  75         MAP_ENUM (MouseCursor, Arrow),
  76         MAP_ENUM (MouseCursor, Hand),
  77         MAP_ENUM (MouseCursor, Wait),
  78         MAP_ENUM (MouseCursor, IBeam),
  79         MAP_ENUM (MouseCursor, Stylus),
  80         MAP_ENUM (MouseCursor, Eraser),
  81         MAP_ENUM (MouseCursor, SizeNS),
  82         MAP_ENUM (MouseCursor, SizeWE),
  83         MAP_ENUM (MouseCursor, None),
  84         END_MAPPING
  85 };
  86
  87 static enum_map_t error_type_map [] = {
  88         MAP_NAME (NoError),
  89         MAP_NAME (UnknownError),
  90         MAP_NAME (InitializeError),
  91         MAP_NAME (ParserError),
  92         MAP_NAME (ObjectModelError),
  93         MAP_NAME (RuntimeError),
  94         MAP_NAME (DownloadError),
  95         MAP_NAME (MediaError),
  96         MAP_NAME (ImageError),
  97         END_MAPPING
  98 };
  99
 100 static enum_map_t fill_behavior_map [] = {
 101         MAP_ENUM (FillBehavior, HoldEnd),
 102         MAP_ENUM (FillBehavior, Stop),
 103         END_MAPPING
 104 };
 105
 106 static enum_map_t fill_rule_map [] = {
 107         MAP_ENUM (FillRule, EvenOdd),
 108         MAP_ENUM (FillRule, Nonzero),
 109         END_MAPPING
 110 };
 111
 112 static enum_map_t font_stretches_map [] = {
 113         MAP_ENUM (FontStretches, UltraCondensed),
 114         MAP_ENUM (FontStretches, ExtraCondensed),
 115         MAP_ENUM (FontStretches, Condensed),
 116         MAP_ENUM (FontStretches, SemiCondensed),
 117         MAP_ENUM (FontStretches, Normal),
 118         MAP_ENUM (FontStretches, Medium),
 119         MAP_ENUM (FontStretches, SemiExpanded),
 120         MAP_ENUM (FontStretches, Expanded),
 121         MAP_ENUM (FontStretches, ExtraExpanded),
 122         MAP_ENUM (FontStretches, UltraExpanded),
 123         END_MAPPING
 124 };
 125
 126 static enum_map_t font_styles_map [] = {
 127         MAP_ENUM (FontStyles, Normal),
 128         MAP_ENUM (FontStyles, Oblique),
 129         MAP_ENUM (FontStyles, Italic),
 130         END_MAPPING
 131 };
 132
 133 static enum_map_t font_weights_map [] = {
 134         MAP_ENUM (FontWeights, Thin),
 135         MAP_ENUM (FontWeights, ExtraLight),
 136         MAP_ENUM_FULL ("UltraLight", FontWeightsExtraLight),  // deprecated as of July 2007
 137         MAP_ENUM (FontWeights, Light),
 138         MAP_ENUM (FontWeights, Normal),
 139         MAP_ENUM_FULL ("Regular", FontWeightsNormal),         // deprecated as of July 2007
 140         MAP_ENUM (FontWeights, Medium),
 141         MAP_ENUM (FontWeights, SemiBold),
 142         MAP_ENUM_FULL ("DemiBold", FontWeightsSemiBold),      // deprecated as of July 2007
 143         MAP_ENUM (FontWeights, Bold),
 144         MAP_ENUM (FontWeights, ExtraBold),
 145         MAP_ENUM_FULL ("UltraBold", FontWeightsExtraBold),    // deprecated as of July 2007
 146         MAP_ENUM (FontWeights, Black),
 147         MAP_ENUM_FULL ("Heavy", FontWeightsBlack),            // deprecated as of July 2007
 148         MAP_ENUM (FontWeights, ExtraBlack),
 149         MAP_ENUM_FULL ("UltraBlack", FontWeightsExtraBlack),  // deprecated as of July 2007
 150         END_MAPPING
 151 };
 152
 153 static enum_map_t line_stacking_strategy_map [] = {
 154         MAP_ENUM (LineStackingStrategy, MaxHeight),
 155         MAP_ENUM (LineStackingStrategy, BlockLineHeight),
 156         END_MAPPING
 157 };
 158
 159 static enum_map_t horizontal_alignment_map [] = {
 160         MAP_ENUM (HorizontalAlignment, Left),
 161         MAP_ENUM (HorizontalAlignment, Center),
 162         MAP_ENUM (HorizontalAlignment, Right),
 163         MAP_ENUM (HorizontalAlignment, Stretch),
 164         END_MAPPING
 165 };
 166
 167 static enum_map_t gradient_spread_method_map [] = {
 168         MAP_ENUM (GradientSpreadMethod, Pad),
 169         MAP_ENUM (GradientSpreadMethod, Reflect),
 170         MAP_ENUM (GradientSpreadMethod, Repeat),
 171         END_MAPPING
 172 };
 173
 174 static enum_map_t keyboard_navigation_mode_map [] = {
 175         MAP_ENUM (KeyboardNavigationMode, Local),
 176         MAP_ENUM (KeyboardNavigationMode, Cycle),
 177         MAP_ENUM (KeyboardNavigationMode, Once),
 178         END_MAPPING
 179 };
 180
 181 static enum_map_t media_element_state_map [] = {
 182         MAP_ENUM (MediaState, Closed),
 183         MAP_ENUM (MediaState, Opening),
 184         MAP_ENUM (MediaState, Buffering),
 185         MAP_ENUM (MediaState, Playing),
 186         MAP_ENUM (MediaState, Paused),
 187         MAP_ENUM (MediaState, Stopped),
 188         MAP_ENUM (MediaState, Individualizing),
 189         MAP_ENUM (MediaState, AcquiringLicense),
 190         MAP_ENUM (MediaState, Error),
 191         END_MAPPING
 192 };
 193
 194 static enum_map_t pen_line_cap_map [] = {
 195         MAP_ENUM (PenLineCap, Flat),
 196         MAP_ENUM (PenLineCap, Square),
 197         MAP_ENUM (PenLineCap, Round),
 198         MAP_ENUM (PenLineCap, Triangle),
 199         END_MAPPING
 200 };
 201
 202 static enum_map_t pen_line_join_map [] = {
 203         MAP_ENUM (PenLineJoin, Miter),
 204         MAP_ENUM (PenLineJoin, Bevel),
 205         MAP_ENUM (PenLineJoin, Round),
 206         END_MAPPING
 207 };
 208
 209 static enum_map_t stretch_map [] = {
 210         MAP_ENUM (Stretch, None),
 211         MAP_ENUM (Stretch, Fill),
 212         MAP_ENUM (Stretch, Uniform),
 213         MAP_ENUM (Stretch, UniformToFill),
 214         END_MAPPING
 215 };
 216
 217 static enum_map_t style_simulations_map [] = {
 218         MAP_ENUM (StyleSimulations, None),
 219         MAP_ENUM_FULL ("BoldSimulation", StyleSimulationsBold),
 220         MAP_ENUM_FULL ("ItalicSimulation", StyleSimulationsItalic),
 221         MAP_ENUM_FULL ("BoldItalicSimulation", StyleSimulationsBoldItalic),
 222         END_MAPPING
 223 };
 224
 225 static enum_map_t sweep_direction_map [] = {
 226         MAP_ENUM (SweepDirection, Counterclockwise),
 227         MAP_ENUM (SweepDirection, Clockwise),
 228         END_MAPPING
 229 };
 230
 231 static enum_map_t tablet_device_type_map [] = {
 232         MAP_ENUM (TabletDeviceType, Mouse),
 233         MAP_ENUM (TabletDeviceType, Stylus),
 234         MAP_ENUM (TabletDeviceType, Touch),
 235         END_MAPPING
 236 };
 237
 238 static enum_map_t text_alignment_map [] = {
 239         MAP_ENUM (TextAlignment, Center),
 240         MAP_ENUM (TextAlignment, Left),
 241         MAP_ENUM (TextAlignment, Right),
 242         END_MAPPING
 243 };
 244
 245 static enum_map_t text_decorations_map [] = {
 246         MAP_ENUM (TextDecorations, None),
 247         MAP_ENUM (TextDecorations, Underline),
 248         END_MAPPING
 249 };
 250
 251 static enum_map_t text_wrapping_map [] = {
 252         MAP_ENUM (TextWrapping, Wrap),
 253         MAP_ENUM (TextWrapping, NoWrap),
 254         MAP_ENUM (TextWrapping, WrapWithOverflow),
 255         END_MAPPING
 256 };
 257
 258 static enum_map_t scrollbar_visibility_map [] = {
 259         MAP_ENUM (ScrollBarVisibility, Disabled),
 260         MAP_ENUM (ScrollBarVisibility, Auto),
 261         MAP_ENUM (ScrollBarVisibility, Hidden),
 262         MAP_ENUM (ScrollBarVisibility, Visible),
 263         END_MAPPING
 264 };
 265
 266 static enum_map_t vertical_alignment_map [] = {
 267         MAP_ENUM (VerticalAlignment, Top),
 268         MAP_ENUM (VerticalAlignment, Center),
 269         MAP_ENUM (VerticalAlignment, Bottom),
 270         MAP_ENUM (VerticalAlignment, Stretch),
 271         END_MAPPING
 272 };
 273
 274 static enum_map_t visibility_map [] = {
 275         MAP_ENUM (Visibility, Visible),
 276         MAP_ENUM (Visibility, Collapsed),
 277         END_MAPPING
 278 };
 279
 280 static enum_map_t orientation_map [] = {
 281         MAP_ENUM (Orientation, Vertical),
 282         MAP_ENUM (Orientation, Horizontal),
 283         END_MAPPING
 284 };
 285
 286 static enum_map_t cross_domain_access_map [] = {
 287         MAP_ENUM (CrossDomainAccess, NoAccess),
 288         MAP_ENUM (CrossDomainAccess, ScriptableOnly),
 289         END_MAPPING
 290 };
 291
 292 static enum_map_t grid_unit_type_map [] = {
 293         MAP_ENUM (GridUnitType, Auto),
 294         MAP_ENUM (GridUnitType, Pixel),
 295         MAP_ENUM (GridUnitType, Star),
 296         END_MAPPING
 297 };
 298
 299 static enum_map_t easing_mode_map [] = {
 300         MAP_ENUM_FULL ("EaseIn", EasingModeIn),
 301         MAP_ENUM_FULL ("EaseOut", EasingModeOut),
 302         MAP_ENUM_FULL ("EaseInOut", EasingModeInOut),
 303         END_MAPPING
 304 };
 305
 306 static void
 307 initialize_enums (void)
 308 {
 309         enum_map = g_hash_table_new (g_str_hash, g_str_equal);
 310
 311         g_hash_table_insert (enum_map, (char *) "AlignmentX", alignment_x_map);
 312         g_hash_table_insert (enum_map, (char *) "AlignmentY", alignment_y_map);
 313         g_hash_table_insert (enum_map, (char *) "MappingMode", brush_mapping_mode_map);
 314         g_hash_table_insert (enum_map, (char *) "ColorInterpolationMode", color_interpolation_mode_map);
 315         g_hash_table_insert (enum_map, (char *) "Cursor", cursors_map);
 316         g_hash_table_insert (enum_map, (char *) "ErrorType", error_type_map);
 317         g_hash_table_insert (enum_map, (char *) "FillBehavior", fill_behavior_map);
 318         g_hash_table_insert (enum_map, (char *) "FillRule", fill_rule_map);
 319         g_hash_table_insert (enum_map, (char *) "FontStretch", font_stretches_map);
 320         g_hash_table_insert (enum_map, (char *) "FontStyle", font_styles_map);
 321         g_hash_table_insert (enum_map, (char *) "FontWeight", font_weights_map);
 322         g_hash_table_insert (enum_map, (char *) "SpreadMethod", gradient_spread_method_map);
 323
 324         g_hash_table_insert (enum_map, (char *) "StrokeDashCap", pen_line_cap_map);
 325         g_hash_table_insert (enum_map, (char *) "StrokeStartLineCap", pen_line_cap_map);
 326         g_hash_table_insert (enum_map, (char *) "StrokeEndLineCap", pen_line_cap_map);
 327
 328         g_hash_table_insert (enum_map, (char *) "StrokeLineJoin", pen_line_join_map);
 329         g_hash_table_insert (enum_map, (char *) "Stretch", stretch_map);
 330         g_hash_table_insert (enum_map, (char *) "StyleSimulations", style_simulations_map);
 331         g_hash_table_insert (enum_map, (char *) "SweepDirection", sweep_direction_map);
 332         g_hash_table_insert (enum_map, (char *) "DeviceType", tablet_device_type_map);
 333         g_hash_table_insert (enum_map, (char *) "TextDecorations", text_decorations_map);
 334         g_hash_table_insert (enum_map, (char *) "TextWrapping", text_wrapping_map);
 335         g_hash_table_insert (enum_map, (char *) "Visibility", visibility_map);
 336
 337         g_hash_table_insert (enum_map, (char *) "BindingMode", binding_mode_map);
 338         g_hash_table_insert (enum_map, (char *) "ExternalCallersFromCrossDomain", cross_domain_access_map);
 339         g_hash_table_insert (enum_map, (char *) "HorizontalScrollBarVisibility", scrollbar_visibility_map);
 340         g_hash_table_insert (enum_map, (char *) "VerticalScrollBarVisibility", scrollbar_visibility_map);
 341         g_hash_table_insert (enum_map, (char *) "LineStackingStrategy", line_stacking_strategy_map);
 342         g_hash_table_insert (enum_map, (char *) "HorizontalAlignment", horizontal_alignment_map);
 343         g_hash_table_insert (enum_map, (char *) "HorizontalContentAlignment", horizontal_alignment_map);
 344         g_hash_table_insert (enum_map, (char *) "VerticalAlignment", vertical_alignment_map);
 345         g_hash_table_insert (enum_map, (char *) "VerticalContentAlignment", vertical_alignment_map);
 346         g_hash_table_insert (enum_map, (char *) "TextAlignment", text_alignment_map);
 347         g_hash_table_insert (enum_map, (char *) "Orientation", orientation_map);
 348
 349         g_hash_table_insert (enum_map, (char *) "TabNavigation", keyboard_navigation_mode_map);
 350
 351         g_hash_table_insert (enum_map, (char *) "MediaState", media_element_state_map);
 352         g_hash_table_insert (enum_map, (char *) "GridUnitType", grid_unit_type_map);
 353
 354         g_hash_table_insert (enum_map, (char *) "EasingMode", easing_mode_map);
 355 }
 356
 357 static int
 358 enum_from_str (const enum_map_t *emu, const char *str)
 359 {
 360         int i;
 361         for (i = 0; emu [i].name; i++) {
 362                 if (!g_ascii_strcasecmp (emu [i].name, str))
 363                         return emu [i].value;
 364         }
 365
 366         return -1;
 367 }
 368
 369 static const char*
 370 str_from_enum (const enum_map_t *emu, int e)
 371 {
 372         int i;
 373         for (i = 0; emu [i].name; i++) {
 374                 if (emu [i].value == e)
 375                         return emu [i].name;
 376         }
 377
 378         return NULL;
 379 }
 380
 381 //
 382 // Converts a string representing an enum (ie. "FillEnd") to int.
 383 // Returns -1 if no property or enum found.
 384 //
 385 int
 386 enums_str_to_int (const char *prop_name, const char *str)
 387 {
 388         if (enum_map == NULL)
 389                 initialize_enums ();
 390
 391         enum_map_t *emu = (enum_map_t *) g_hash_table_lookup (enum_map, prop_name);
 392         if (! emu)
 393                 return -1;
 394
 395         return enum_from_str (emu, str);
 396 }
 397
 398 //
 399 // Converts an int enum to a string representation.
 400 // Returns NULL if no match found.
 401 //
 402 const char *
 403 enums_int_to_str (const char *prop_name, int e)
 404 {
 405         if (enum_map == NULL)
 406                 initialize_enums ();
 407
 408         enum_map_t *emu = (enum_map_t *) g_hash_table_lookup (enum_map, prop_name);
 409         if (! emu)
 410                 return NULL;
 411
 412         return str_from_enum (emu, e);
 413 }
 414
 415 bool
 416 enums_is_enum_name (const char *enum_name)
 417 {
 418         if (enum_map == NULL)
 419                 initialize_enums ();
 420
 421         return g_hash_table_lookup (enum_map, enum_name) != NULL;
 422 }