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