src/verbs.h

   1 #ifndef SEEN_SP_VERBS_H
   2 #define SEEN_SP_VERBS_H
   3
   4 /** \file
   5  * \brief Frontend to actions
   6  *
   7  * Author:
   8  *   Lauris Kaplinski <lauris@kaplinski.com>
   9  *   Ted Gould <ted@gould.cx>
  10  *   David Yip <yipdw@rose-hulman.edu>
  11  *
  12  *  Copyright (C) 2006 Johan Engelen <johan@shouraizou.nl>
  13  *  Copyright (C) (date unspecified) Authors
  14
  15  * This code is in public domain if done by Lauris
  16  * This code is GPL if done by Ted or David
  17  */
  18
  19 #include <cstring>
  20 #include <string>
  21 #include <string.h>
  22 #include "require-config.h"   /* HAVE_GTK_WINDOW_FULLSCREEN */
  23 #include "helper/helper-forward.h"
  24 #include "forward.h"
  25 #include <glibmm/ustring.h>
  26
  27 /** \brief This anonymous enum is used to provide a list of the Verbs
  28            which are defined staticly in the verb files.  There may be
  29            other verbs which are defined dynamically also. */
  30 enum {
  31     /* Header */
  32     SP_VERB_INVALID,               /**< A dummy verb to represent doing something wrong. */
  33     SP_VERB_NONE,                  /**< A dummy verb to represent not having a verb. */
  34     /* File */
  35     SP_VERB_FILE_NEW,              /**< A new file in a new window. */
  36     SP_VERB_FILE_OPEN,             /**< Open a file. */
  37     SP_VERB_FILE_REVERT,           /**< Revert this file to its original state. */
  38     SP_VERB_FILE_SAVE,             /**< Save the current file with its saved filename */
  39     SP_VERB_FILE_SAVE_AS,          /**< Save the current file with a new filename */
  40     SP_VERB_FILE_SAVE_A_COPY,      /**< Save a copy of the current file */
  41     SP_VERB_FILE_PRINT,
  42     SP_VERB_FILE_VACUUM,
  43     SP_VERB_FILE_PRINT_PREVIEW,
  44     SP_VERB_FILE_IMPORT,
  45     SP_VERB_FILE_EXPORT,
  46     SP_VERB_FILE_IMPORT_FROM_OCAL, /**< Import the file from Open Clip Art Library */
  47     SP_VERB_FILE_EXPORT_TO_OCAL, /**< Export the file to Open Clip Art  Library */
  48     SP_VERB_FILE_NEXT_DESKTOP,
  49     SP_VERB_FILE_PREV_DESKTOP,
  50     SP_VERB_FILE_CLOSE_VIEW,
  51     SP_VERB_FILE_QUIT,
  52     /* Edit */
  53     SP_VERB_EDIT_UNDO,
  54     SP_VERB_EDIT_REDO,
  55     SP_VERB_EDIT_CUT,
  56     SP_VERB_EDIT_COPY,
  57     SP_VERB_EDIT_PASTE,
  58     SP_VERB_EDIT_PASTE_STYLE,
  59     SP_VERB_EDIT_PASTE_SIZE,
  60     SP_VERB_EDIT_PASTE_SIZE_X,
  61     SP_VERB_EDIT_PASTE_SIZE_Y,
  62     SP_VERB_EDIT_PASTE_SIZE_SEPARATELY,
  63     SP_VERB_EDIT_PASTE_SIZE_SEPARATELY_X,
  64     SP_VERB_EDIT_PASTE_SIZE_SEPARATELY_Y,
  65     SP_VERB_EDIT_PASTE_IN_PLACE,
  66     SP_VERB_EDIT_PASTE_LIVEPATHEFFECT,
  67     SP_VERB_EDIT_REMOVE_LIVEPATHEFFECT,
  68     SP_VERB_EDIT_REMOVE_FILTER,
  69     SP_VERB_EDIT_DELETE,
  70     SP_VERB_EDIT_DUPLICATE,
  71     SP_VERB_EDIT_CLONE,
  72     SP_VERB_EDIT_UNLINK_CLONE,
  73     SP_VERB_EDIT_RELINK_CLONE,
  74     SP_VERB_EDIT_CLONE_SELECT_ORIGINAL,
  75     SP_VERB_EDIT_SELECTION_2_MARKER,
  76     SP_VERB_EDIT_SELECTION_2_GUIDES,
  77     SP_VERB_EDIT_TILE,
  78     SP_VERB_EDIT_UNTILE,
  79     SP_VERB_EDIT_CLEAR_ALL,
  80     SP_VERB_EDIT_SELECT_ALL,
  81     SP_VERB_EDIT_SELECT_ALL_IN_ALL_LAYERS,
  82     SP_VERB_EDIT_INVERT,
  83     SP_VERB_EDIT_INVERT_IN_ALL_LAYERS,
  84     SP_VERB_EDIT_SELECT_NEXT,
  85     SP_VERB_EDIT_SELECT_PREV,
  86     SP_VERB_EDIT_DESELECT,
  87     SP_VERB_EDIT_GUIDES_AROUND_PAGE,
  88     SP_VERB_EDIT_NEXT_PATHEFFECT_PARAMETER,
  89     /* Selection */
  90     SP_VERB_SELECTION_TO_FRONT,
  91     SP_VERB_SELECTION_TO_BACK,
  92     SP_VERB_SELECTION_RAISE,
  93     SP_VERB_SELECTION_LOWER,
  94     SP_VERB_SELECTION_GROUP,
  95     SP_VERB_SELECTION_UNGROUP,
  96     SP_VERB_SELECTION_TEXTTOPATH,
  97     SP_VERB_SELECTION_TEXTFROMPATH,
  98     SP_VERB_SELECTION_REMOVE_KERNS,
  99     SP_VERB_SELECTION_UNION,
 100     SP_VERB_SELECTION_INTERSECT,
 101     SP_VERB_SELECTION_DIFF,
 102     SP_VERB_SELECTION_SYMDIFF,
 103     SP_VERB_SELECTION_CUT,
 104     SP_VERB_SELECTION_SLICE,
 105     SP_VERB_SELECTION_OFFSET,
 106     SP_VERB_SELECTION_OFFSET_SCREEN,
 107     SP_VERB_SELECTION_OFFSET_SCREEN_10,
 108     SP_VERB_SELECTION_INSET,
 109     SP_VERB_SELECTION_INSET_SCREEN,
 110     SP_VERB_SELECTION_INSET_SCREEN_10,
 111     SP_VERB_SELECTION_DYNAMIC_OFFSET,
 112     SP_VERB_SELECTION_LINKED_OFFSET,
 113     SP_VERB_SELECTION_OUTLINE,
 114     SP_VERB_SELECTION_SIMPLIFY,
 115     SP_VERB_SELECTION_REVERSE,
 116     SP_VERB_SELECTION_TRACE,
 117     SP_VERB_SELECTION_CREATE_BITMAP,
 118     SP_VERB_SELECTION_COMBINE,
 119     SP_VERB_SELECTION_BREAK_APART,
 120     SP_VERB_SELECTION_GRIDTILE,
 121     /* Layer */
 122     SP_VERB_LAYER_NEW,
 123     SP_VERB_LAYER_RENAME,
 124     SP_VERB_LAYER_NEXT,
 125     SP_VERB_LAYER_PREV,
 126     SP_VERB_LAYER_MOVE_TO_NEXT,
 127     SP_VERB_LAYER_MOVE_TO_PREV,
 128     SP_VERB_LAYER_TO_TOP,
 129     SP_VERB_LAYER_TO_BOTTOM,
 130     SP_VERB_LAYER_RAISE,
 131     SP_VERB_LAYER_LOWER,
 132     SP_VERB_LAYER_DUPLICATE,
 133     SP_VERB_LAYER_DELETE,
 134     SP_VERB_LAYER_SOLO,
 135     /* Object */
 136     SP_VERB_OBJECT_ROTATE_90_CW,
 137     SP_VERB_OBJECT_ROTATE_90_CCW,
 138     SP_VERB_OBJECT_FLATTEN,
 139     SP_VERB_OBJECT_TO_CURVE,
 140     SP_VERB_OBJECT_FLOW_TEXT,
 141     SP_VERB_OBJECT_UNFLOW_TEXT,
 142     SP_VERB_OBJECT_FLOWTEXT_TO_TEXT,
 143     SP_VERB_OBJECT_FLIP_HORIZONTAL,
 144     SP_VERB_OBJECT_FLIP_VERTICAL,
 145     SP_VERB_OBJECT_SET_MASK,
 146     SP_VERB_OBJECT_EDIT_MASK,
 147     SP_VERB_OBJECT_UNSET_MASK,
 148     SP_VERB_OBJECT_SET_CLIPPATH,
 149     SP_VERB_OBJECT_EDIT_CLIPPATH,
 150     SP_VERB_OBJECT_UNSET_CLIPPATH,
 151     /* Tools */
 152     SP_VERB_CONTEXT_SELECT,
 153     SP_VERB_CONTEXT_NODE,
 154     SP_VERB_CONTEXT_TWEAK,
 155     SP_VERB_CONTEXT_RECT,
 156     SP_VERB_CONTEXT_3DBOX,
 157     SP_VERB_CONTEXT_ARC,
 158     SP_VERB_CONTEXT_STAR,
 159     SP_VERB_CONTEXT_SPIRAL,
 160     SP_VERB_CONTEXT_PENCIL,
 161     SP_VERB_CONTEXT_PEN,
 162     SP_VERB_CONTEXT_CALLIGRAPHIC,
 163     SP_VERB_CONTEXT_TEXT,
 164     SP_VERB_CONTEXT_GRADIENT,
 165     SP_VERB_CONTEXT_ZOOM,
 166     SP_VERB_CONTEXT_DROPPER,
 167     SP_VERB_CONTEXT_CONNECTOR,
 168     SP_VERB_CONTEXT_PAINTBUCKET,
 169     SP_VERB_CONTEXT_LPE, /* not really a tool but used for editing LPE parameters on-canvas for example */
 170     SP_VERB_CONTEXT_ERASER,
 171     SP_VERB_CONTEXT_LPETOOL, /* note that this is very different from SP_VERB_CONTEXT_LPE above! */
 172     /* Tool preferences */
 173     SP_VERB_CONTEXT_SELECT_PREFS,
 174     SP_VERB_CONTEXT_NODE_PREFS,
 175     SP_VERB_CONTEXT_TWEAK_PREFS,
 176     SP_VERB_CONTEXT_RECT_PREFS,
 177     SP_VERB_CONTEXT_3DBOX_PREFS,
 178     SP_VERB_CONTEXT_ARC_PREFS,
 179     SP_VERB_CONTEXT_STAR_PREFS,
 180     SP_VERB_CONTEXT_SPIRAL_PREFS,
 181     SP_VERB_CONTEXT_PENCIL_PREFS,
 182     SP_VERB_CONTEXT_PEN_PREFS,
 183     SP_VERB_CONTEXT_CALLIGRAPHIC_PREFS,
 184     SP_VERB_CONTEXT_TEXT_PREFS,
 185     SP_VERB_CONTEXT_GRADIENT_PREFS,
 186     SP_VERB_CONTEXT_ZOOM_PREFS,
 187     SP_VERB_CONTEXT_DROPPER_PREFS,
 188     SP_VERB_CONTEXT_CONNECTOR_PREFS,
 189     SP_VERB_CONTEXT_PAINTBUCKET_PREFS,
 190     SP_VERB_CONTEXT_ERASER_PREFS,
 191     SP_VERB_CONTEXT_LPETOOL_PREFS,
 192     /* Zooming and desktop settings */
 193     SP_VERB_ZOOM_IN,
 194     SP_VERB_ZOOM_OUT,
 195     SP_VERB_TOGGLE_RULERS,
 196     SP_VERB_TOGGLE_SCROLLBARS,
 197     SP_VERB_TOGGLE_GRID,
 198     SP_VERB_TOGGLE_GUIDES,
 199     SP_VERB_TOGGLE_SNAPPING,
 200     SP_VERB_ZOOM_NEXT,
 201     SP_VERB_ZOOM_PREV,
 202     SP_VERB_ZOOM_1_1,
 203     SP_VERB_ZOOM_1_2,
 204     SP_VERB_ZOOM_2_1,
 205 #ifdef HAVE_GTK_WINDOW_FULLSCREEN
 206     SP_VERB_FULLSCREEN,
 207 #endif /* HAVE_GTK_WINDOW_FULLSCREEN */
 208     SP_VERB_VIEW_NEW,
 209     SP_VERB_VIEW_NEW_PREVIEW,
 210     SP_VERB_VIEW_MODE_NORMAL,
 211     SP_VERB_VIEW_MODE_NO_FILTERS,
 212     SP_VERB_VIEW_MODE_OUTLINE,
 213     SP_VERB_VIEW_MODE_TOGGLE,
 214     SP_VERB_VIEW_CMS_TOGGLE,
 215     SP_VERB_VIEW_ICON_PREVIEW,
 216     SP_VERB_ZOOM_PAGE,
 217     SP_VERB_ZOOM_PAGE_WIDTH,
 218     SP_VERB_ZOOM_DRAWING,
 219     SP_VERB_ZOOM_SELECTION,
 220     /* Dialogs */
 221     SP_VERB_DIALOG_DISPLAY,
 222     SP_VERB_DIALOG_NAMEDVIEW,
 223     SP_VERB_DIALOG_METADATA,
 224     SP_VERB_DIALOG_FILL_STROKE,
 225     SP_VERB_DIALOG_SWATCHES,
 226     SP_VERB_DIALOG_TRANSFORM,
 227     SP_VERB_DIALOG_ALIGN_DISTRIBUTE,
 228     SP_VERB_DIALOG_UNDO_HISTORY,
 229     SP_VERB_DIALOG_TEXT,
 230     SP_VERB_DIALOG_XML_EDITOR,
 231     SP_VERB_DIALOG_FIND,
 232     SP_VERB_DIALOG_DEBUG,
 233     SP_VERB_DIALOG_SCRIPT,
 234     SP_VERB_DIALOG_TOGGLE,
 235     SP_VERB_DIALOG_CLONETILER,
 236     SP_VERB_DIALOG_ITEM,
 237 #ifdef WITH_INKBOARD
 238     SP_VERB_XMPP_CLIENT,
 239 #endif
 240     SP_VERB_DIALOG_INPUT,
 241     SP_VERB_DIALOG_INPUT2,
 242     SP_VERB_DIALOG_EXTENSIONEDITOR,
 243     SP_VERB_DIALOG_LAYERS,
 244     SP_VERB_DIALOG_LIVE_PATH_EFFECT,
 245     SP_VERB_DIALOG_FILTER_EFFECTS,
 246     SP_VERB_DIALOG_SVG_FONTS,
 247     /* Help */
 248     SP_VERB_HELP_ABOUT_EXTENSIONS,
 249     SP_VERB_HELP_MEMORY,
 250     SP_VERB_HELP_ABOUT,
 251     //SP_VERB_SHOW_LICENSE,
 252     /* Tutorials */
 253     SP_VERB_TUTORIAL_BASIC,
 254     SP_VERB_TUTORIAL_SHAPES,
 255     SP_VERB_TUTORIAL_ADVANCED,
 256     SP_VERB_TUTORIAL_TRACING,
 257     SP_VERB_TUTORIAL_CALLIGRAPHY,
 258     SP_VERB_TUTORIAL_DESIGN,
 259     SP_VERB_TUTORIAL_TIPS,
 260     /* Effects */
 261     SP_VERB_EFFECT_LAST,
 262     SP_VERB_EFFECT_LAST_PREF,
 263     /* Fit Canvas */
 264     SP_VERB_FIT_CANVAS_TO_SELECTION,
 265     SP_VERB_FIT_CANVAS_TO_DRAWING,
 266     SP_VERB_FIT_CANVAS_TO_SELECTION_OR_DRAWING,
 267     /* LockAndHide */
 268     SP_VERB_UNLOCK_ALL,
 269     SP_VERB_UNLOCK_ALL_IN_ALL_LAYERS,
 270     SP_VERB_UNHIDE_ALL,
 271     SP_VERB_UNHIDE_ALL_IN_ALL_LAYERS,
 272     /* Footer */
 273     SP_VERB_LAST
 274 };
 275
 276 gchar *sp_action_get_title (const SPAction *action);
 277
 278 #include <map>
 279
 280 namespace Inkscape {
 281
 282 /** \brief A class to represent things the user can do.  In many ways
 283            these are 'action factories' as they are used to create
 284            individual actions that are based on a given view.
 285 */
 286 class Verb {
 287 private:
 288     /** \brief An easy to use defition of the table of verbs by code. */
 289     typedef std::map<unsigned int, Inkscape::Verb *> VerbTable;
 290     /** \brief A table of all the dynamically created verbs. */
 291     static VerbTable _verbs;
 292     /** \brief The table of statically created verbs which are mostly
 293                'base verbs'. */
 294     static Verb * _base_verbs[SP_VERB_LAST + 1];
 295     /* Plus one because there is an entry for SP_VERB_LAST */
 296     /** A string comparison function to be used in the Verb ID lookup
 297         to find the different verbs in the hash map. */
 298     struct ltstr {
 299         bool operator()(const char* s1, const char* s2) const {
 300             if ( (s1 == NULL) && (s2 != NULL) ) {
 301                 return true;
 302             } else if (s1 == NULL || s2 == NULL) {
 303                 return false;
 304             } else {
 305                 return strcmp(s1, s2) < 0;
 306             }
 307         }
 308     };
 309     /** \brief An easy to use definition of the table of verbs by ID. */
 310     typedef std::map<gchar const *, Verb *, ltstr> VerbIDTable;
 311     /** \brief Quick lookup of verbs by ID */
 312     static VerbIDTable _verb_ids;
 313
 314     /** \brief A simple typedef to make using the action table easier. */
 315     typedef std::map<Inkscape::UI::View::View *, SPAction *> ActionTable;
 316     /** \brief A list of all the actions that have been created for this
 317                verb.  It is referenced by the view that they are created for. */
 318     ActionTable * _actions;
 319
 320     /** \brief A unique textual ID for the verb. */
 321     gchar const * _id;
 322     /** \brief The full name of the verb.  (shown on menu entries) */
 323     gchar const * _name;
 324     /** \brief Tooltip for the verb. */
 325     gchar const * _tip;
 326     /** \brief Name of the image that represents the verb. */
 327     gchar const * _image;
 328     /** \brief Unique numerical representation of the verb.  In most cases
 329                it is a value from the anonymous enum at the top of this
 330                file. */
 331     unsigned int  _code;
 332
 333     /** \brief Whether this verb is set to default to sensitive or
 334                insensitive when new actions are created. */
 335     bool _default_sensitive;
 336 protected:
 337     /** \brief Allows for preliminary setting of the \c _default_sensitive
 338                value without effecting existing actions
 339         \param in_val New value
 340
 341         This function is mostly used at initialization where there are
 342         not actions to effect.  I can't think of another case where it
 343         should be used.
 344     */
 345     bool set_default_sensitive (bool in_val) { return _default_sensitive = in_val; }
 346 public:
 347     /** \brief Accessor to get the \c _default_sensitive value */
 348     bool get_default_sensitive (void) { return _default_sensitive; }
 349
 350 public:
 351     /** \brief Accessor to get the internal variable. */
 352     unsigned int get_code (void) { return _code; }
 353     /** \brief Accessor to get the internal variable. */
 354     gchar const * get_id (void) { return _id; }
 355     /** \brief Accessor to get the internal variable. */
 356     gchar const * get_name (void) { return _name; }
 357     /** \brief Accessor to get the internal variable. */
 358     gchar const * get_tip (void) ;
 359     /** \brief Accessor to get the internal variable. */
 360     gchar const * get_image (void) { return _image; }
 361
 362     /** \brief Set the name after initialization. */
 363     gchar const * set_name (gchar const * name) { _name = name; return _name; }
 364     /** \brief Set the tooltip after initialization. */
 365     gchar const * set_tip (gchar const * tip) { _tip = tip; return _tip; }
 366
 367 protected:
 368     SPAction * make_action_helper (Inkscape::UI::View::View * view, SPActionEventVector * vector, void * in_pntr = NULL);
 369     virtual SPAction * make_action (Inkscape::UI::View::View * view);
 370
 371 public:
 372     /** \brief Inititalizes the Verb with the parameters
 373         \param code  Goes to \c _code
 374         \param id    Goes to \c _id
 375         \param name  Goes to \c _name
 376         \param tip   Goes to \c _tip
 377         \param image Goes to \c _image
 378
 379         This function also sets \c _actions to NULL.
 380
 381         \warning NO DATA IS COPIED BY CALLING THIS FUNCTION.
 382
 383         In many respects this is very bad object oriented design, but it
 384         is done for a reason.  All verbs today are of two types: 1) static
 385         or 2) created for extension.  In the static case all of the
 386         strings are constants in the code, and thus don't really need to
 387         be copied.  In the extensions case the strings are identical to
 388         the ones already created in the extension object, copying them
 389         would be a waste of memory.
 390     */
 391     Verb(const unsigned int code,
 392          gchar const * id,
 393          gchar const * name,
 394          gchar const * tip,
 395          gchar const * image) :
 396         _actions(NULL), _id(id), _name(name), _tip(tip), _image(image), _code(code), _default_sensitive(true) {
 397         _verbs.insert(VerbTable::value_type(_code, this));
 398         _verb_ids.insert(VerbIDTable::value_type(_id, this));
 399     }
 400     Verb (gchar const * id, gchar const * name, gchar const * tip, gchar const * image);
 401     virtual ~Verb (void);
 402
 403     SPAction * get_action(Inkscape::UI::View::View * view);
 404
 405 private:
 406     static Verb * get_search (unsigned int code);
 407 public:
 408     /** \brief A function to turn a code into a verb.
 409         \param  code  The code to be translated
 410         \return A pointer to a verb object or a NULL if not found.
 411
 412         This is an inline function to translate the codes which are
 413         static quickly.  This should optimize into very quick code
 414         everywhere which hard coded \c codes are used.  In the case
 415         where the \c code is not static the \c get_search function
 416         is used.
 417     */
 418     static Verb * get (unsigned int code) {
 419         if (code <= SP_VERB_LAST) {
 420             return _base_verbs[code];
 421         } else {
 422             return get_search(code);
 423         }
 424     }
 425     static Verb * getbyid (gchar const * id);
 426
 427     static void delete_all_view (Inkscape::UI::View::View * view);
 428     void delete_view (Inkscape::UI::View::View * view);
 429
 430     void sensitive (SPDocument * in_doc = NULL, bool in_sensitive = true);
 431     void name (SPDocument * in_doc = NULL, Glib::ustring in_name = "");
 432
 433 // Yes, multiple public, protected and private sections are bad. We'll clean that up later
 434 protected:
 435     /** \brief Returns the size of the internal base verb array.
 436         \return The size in elements of the internal base array.
 437
 438         This is an inline function intended for testing. This should normally not be used.
 439         For testing, a subclass that returns this value can be created to verify that the
 440         length matches the enum values, etc.
 441     */
 442     static int _getBaseListSize(void) {return G_N_ELEMENTS(_base_verbs);}
 443
 444 public:
 445     static void list (void);
 446 }; /* Verb class */
 447
 448
 449 }  /* Inkscape namespace */
 450
 451 #endif // SEEN_SP_VERBS_H
 452
 453 /*
 454   Local Variables:
 455   mode:c++
 456   c-file-style:"stroustrup"
 457   c-file-offsets:((innamespace . 0)(inline-open . 0))
 458   indent-tabs-mode:nil
 459   fill-column:99
 460   End:
 461 */
 462 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :