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_FOCUSTOGGLE,
 209     SP_VERB_VIEW_NEW,
 210     SP_VERB_VIEW_NEW_PREVIEW,
 211     SP_VERB_VIEW_MODE_NORMAL,
 212     SP_VERB_VIEW_MODE_NO_FILTERS,
 213     SP_VERB_VIEW_MODE_OUTLINE,
 214     SP_VERB_VIEW_MODE_TOGGLE,
 215     SP_VERB_VIEW_CMS_TOGGLE,
 216     SP_VERB_VIEW_ICON_PREVIEW,
 217     SP_VERB_ZOOM_PAGE,
 218     SP_VERB_ZOOM_PAGE_WIDTH,
 219     SP_VERB_ZOOM_DRAWING,
 220     SP_VERB_ZOOM_SELECTION,
 221     /* Dialogs */
 222     SP_VERB_DIALOG_DISPLAY,
 223     SP_VERB_DIALOG_NAMEDVIEW,
 224     SP_VERB_DIALOG_METADATA,
 225     SP_VERB_DIALOG_FILL_STROKE,
 226     SP_VERB_DIALOG_SWATCHES,
 227     SP_VERB_DIALOG_TRANSFORM,
 228     SP_VERB_DIALOG_ALIGN_DISTRIBUTE,
 229     SP_VERB_DIALOG_UNDO_HISTORY,
 230     SP_VERB_DIALOG_TEXT,
 231     SP_VERB_DIALOG_XML_EDITOR,
 232     SP_VERB_DIALOG_FIND,
 233     SP_VERB_DIALOG_DEBUG,
 234     SP_VERB_DIALOG_SCRIPT,
 235     SP_VERB_DIALOG_TOGGLE,
 236     SP_VERB_DIALOG_CLONETILER,
 237     SP_VERB_DIALOG_ITEM,
 238 #ifdef WITH_INKBOARD
 239     SP_VERB_XMPP_CLIENT,
 240 #endif
 241     SP_VERB_DIALOG_INPUT,
 242     SP_VERB_DIALOG_INPUT2,
 243     SP_VERB_DIALOG_EXTENSIONEDITOR,
 244     SP_VERB_DIALOG_LAYERS,
 245     SP_VERB_DIALOG_LIVE_PATH_EFFECT,
 246     SP_VERB_DIALOG_FILTER_EFFECTS,
 247     SP_VERB_DIALOG_SVG_FONTS,
 248     /* Help */
 249     SP_VERB_HELP_ABOUT_EXTENSIONS,
 250     SP_VERB_HELP_MEMORY,
 251     SP_VERB_HELP_ABOUT,
 252     //SP_VERB_SHOW_LICENSE,
 253     /* Tutorials */
 254     SP_VERB_TUTORIAL_BASIC,
 255     SP_VERB_TUTORIAL_SHAPES,
 256     SP_VERB_TUTORIAL_ADVANCED,
 257     SP_VERB_TUTORIAL_TRACING,
 258     SP_VERB_TUTORIAL_CALLIGRAPHY,
 259     SP_VERB_TUTORIAL_DESIGN,
 260     SP_VERB_TUTORIAL_TIPS,
 261     /* Effects */
 262     SP_VERB_EFFECT_LAST,
 263     SP_VERB_EFFECT_LAST_PREF,
 264     /* Fit Canvas */
 265     SP_VERB_FIT_CANVAS_TO_SELECTION,
 266     SP_VERB_FIT_CANVAS_TO_DRAWING,
 267     SP_VERB_FIT_CANVAS_TO_SELECTION_OR_DRAWING,
 268     /* LockAndHide */
 269     SP_VERB_UNLOCK_ALL,
 270     SP_VERB_UNLOCK_ALL_IN_ALL_LAYERS,
 271     SP_VERB_UNHIDE_ALL,
 272     SP_VERB_UNHIDE_ALL_IN_ALL_LAYERS,
 273     /* Footer */
 274     SP_VERB_LAST
 275 };
 276
 277 gchar *sp_action_get_title (const SPAction *action);
 278
 279 #include <map>
 280
 281 namespace Inkscape {
 282
 283 /** \brief A class to represent things the user can do.  In many ways
 284            these are 'action factories' as they are used to create
 285            individual actions that are based on a given view.
 286 */
 287 class Verb {
 288 private:
 289     /** \brief An easy to use defition of the table of verbs by code. */
 290     typedef std::map<unsigned int, Inkscape::Verb *> VerbTable;
 291     /** \brief A table of all the dynamically created verbs. */
 292     static VerbTable _verbs;
 293     /** \brief The table of statically created verbs which are mostly
 294                'base verbs'. */
 295     static Verb * _base_verbs[SP_VERB_LAST + 1];
 296     /* Plus one because there is an entry for SP_VERB_LAST */
 297     /** A string comparison function to be used in the Verb ID lookup
 298         to find the different verbs in the hash map. */
 299     struct ltstr {
 300         bool operator()(const char* s1, const char* s2) const {
 301             if ( (s1 == NULL) && (s2 != NULL) ) {
 302                 return true;
 303             } else if (s1 == NULL || s2 == NULL) {
 304                 return false;
 305             } else {
 306                 return strcmp(s1, s2) < 0;
 307             }
 308         }
 309     };
 310     /** \brief An easy to use definition of the table of verbs by ID. */
 311     typedef std::map<gchar const *, Verb *, ltstr> VerbIDTable;
 312     /** \brief Quick lookup of verbs by ID */
 313     static VerbIDTable _verb_ids;
 314
 315     /** \brief A simple typedef to make using the action table easier. */
 316     typedef std::map<Inkscape::UI::View::View *, SPAction *> ActionTable;
 317     /** \brief A list of all the actions that have been created for this
 318                verb.  It is referenced by the view that they are created for. */
 319     ActionTable * _actions;
 320
 321     /** \brief A unique textual ID for the verb. */
 322     gchar const * _id;
 323     /** \brief The full name of the verb.  (shown on menu entries) */
 324     gchar const * _name;
 325     /** \brief Tooltip for the verb. */
 326     gchar const * _tip;
 327     /** \brief Name of the image that represents the verb. */
 328     gchar const * _image;
 329     /** \brief Unique numerical representation of the verb.  In most cases
 330                it is a value from the anonymous enum at the top of this
 331                file. */
 332     unsigned int  _code;
 333
 334     /** \brief Whether this verb is set to default to sensitive or
 335                insensitive when new actions are created. */
 336     bool _default_sensitive;
 337 protected:
 338     /** \brief Allows for preliminary setting of the \c _default_sensitive
 339                value without effecting existing actions
 340         \param in_val New value
 341
 342         This function is mostly used at initialization where there are
 343         not actions to effect.  I can't think of another case where it
 344         should be used.
 345     */
 346     bool set_default_sensitive (bool in_val) { return _default_sensitive = in_val; }
 347 public:
 348     /** \brief Accessor to get the \c _default_sensitive value */
 349     bool get_default_sensitive (void) { return _default_sensitive; }
 350
 351 public:
 352     /** \brief Accessor to get the internal variable. */
 353     unsigned int get_code (void) { return _code; }
 354     /** \brief Accessor to get the internal variable. */
 355     gchar const * get_id (void) { return _id; }
 356     /** \brief Accessor to get the internal variable. */
 357     gchar const * get_name (void) { return _name; }
 358     /** \brief Accessor to get the internal variable. */
 359     gchar const * get_tip (void) ;
 360     /** \brief Accessor to get the internal variable. */
 361     gchar const * get_image (void) { return _image; }
 362
 363     /** \brief Set the name after initialization. */
 364     gchar const * set_name (gchar const * name) { _name = name; return _name; }
 365     /** \brief Set the tooltip after initialization. */
 366     gchar const * set_tip (gchar const * tip) { _tip = tip; return _tip; }
 367
 368 protected:
 369     SPAction * make_action_helper (Inkscape::UI::View::View * view, SPActionEventVector * vector, void * in_pntr = NULL);
 370     virtual SPAction * make_action (Inkscape::UI::View::View * view);
 371
 372 public:
 373     /** \brief Inititalizes the Verb with the parameters
 374         \param code  Goes to \c _code
 375         \param id    Goes to \c _id
 376         \param name  Goes to \c _name
 377         \param tip   Goes to \c _tip
 378         \param image Goes to \c _image
 379
 380         This function also sets \c _actions to NULL.
 381
 382         \warning NO DATA IS COPIED BY CALLING THIS FUNCTION.
 383
 384         In many respects this is very bad object oriented design, but it
 385         is done for a reason.  All verbs today are of two types: 1) static
 386         or 2) created for extension.  In the static case all of the
 387         strings are constants in the code, and thus don't really need to
 388         be copied.  In the extensions case the strings are identical to
 389         the ones already created in the extension object, copying them
 390         would be a waste of memory.
 391     */
 392     Verb(const unsigned int code,
 393          gchar const * id,
 394          gchar const * name,
 395          gchar const * tip,
 396          gchar const * image) :
 397         _actions(NULL), _id(id), _name(name), _tip(tip), _image(image), _code(code), _default_sensitive(true) {
 398         _verbs.insert(VerbTable::value_type(_code, this));
 399         _verb_ids.insert(VerbIDTable::value_type(_id, this));
 400     }
 401     Verb (gchar const * id, gchar const * name, gchar const * tip, gchar const * image);
 402     virtual ~Verb (void);
 403
 404     SPAction * get_action(Inkscape::UI::View::View * view);
 405
 406 private:
 407     static Verb * get_search (unsigned int code);
 408 public:
 409     /** \brief A function to turn a code into a verb.
 410         \param  code  The code to be translated
 411         \return A pointer to a verb object or a NULL if not found.
 412
 413         This is an inline function to translate the codes which are
 414         static quickly.  This should optimize into very quick code
 415         everywhere which hard coded \c codes are used.  In the case
 416         where the \c code is not static the \c get_search function
 417         is used.
 418     */
 419     static Verb * get (unsigned int code) {
 420         if (code <= SP_VERB_LAST) {
 421             return _base_verbs[code];
 422         } else {
 423             return get_search(code);
 424         }
 425     }
 426     static Verb * getbyid (gchar const * id);
 427
 428     static void delete_all_view (Inkscape::UI::View::View * view);
 429     void delete_view (Inkscape::UI::View::View * view);
 430
 431     void sensitive (SPDocument * in_doc = NULL, bool in_sensitive = true);
 432     void name (SPDocument * in_doc = NULL, Glib::ustring in_name = "");
 433
 434 // Yes, multiple public, protected and private sections are bad. We'll clean that up later
 435 protected:
 436     /** \brief Returns the size of the internal base verb array.
 437         \return The size in elements of the internal base array.
 438
 439         This is an inline function intended for testing. This should normally not be used.
 440         For testing, a subclass that returns this value can be created to verify that the
 441         length matches the enum values, etc.
 442     */
 443     static int _getBaseListSize(void) {return G_N_ELEMENTS(_base_verbs);}
 444
 445 public:
 446     static void list (void);
 447 }; /* Verb class */
 448
 449
 450 }  /* Inkscape namespace */
 451
 452 #endif // SEEN_SP_VERBS_H
 453
 454 /*
 455   Local Variables:
 456   mode:c++
 457   c-file-style:"stroustrup"
 458   c-file-offsets:((innamespace . 0)(inline-open . 0))
 459   indent-tabs-mode:nil
 460   fill-column:99
 461   End:
 462 */
 463 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :