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