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