src/MacVim/MacVim.h

   1 /* vi:set ts=8 sts=4 sw=4 ft=objc:
   2  *
   3  * VIM - Vi IMproved            by Bram Moolenaar
   4  *                              MacVim GUI port by Bjorn Winckler
   5  *
   6  * Do ":help uganda"  in Vim to read copying and usage conditions.
   7  * Do ":help credits" in Vim to see a list of people who contributed.
   8  * See README.txt for an overview of the Vim source code.
   9  */
  10
  11 #import <Cocoa/Cocoa.h>
  12 #import <asl.h>
  13
  14
  15 //
  16 // Uncomment to enable support for MacVim plugins (not to be confused with Vim
  17 // plugins!).
  18 //
  19 //#define MM_ENABLE_PLUGINS
  20
  21
  22 // Taken from /usr/include/AvailabilityMacros.h
  23 #ifndef MAC_OS_X_VERSION_10_4
  24 # define MAC_OS_X_VERSION_10_4 1040
  25 #endif
  26 #ifndef MAC_OS_X_VERSION_10_5
  27 # define MAC_OS_X_VERSION_10_5 1050
  28 #endif
  29 #ifndef MAC_OS_X_VERSION_10_6
  30 # define MAC_OS_X_VERSION_10_6 1060
  31 #endif
  32
  33
  34
  35 //
  36 // This is the protocol MMBackend implements.
  37 //
  38 // Only processInput:data: is allowed to cause state changes in Vim; all other
  39 // messages should only read the Vim state.  (Note that setDialogReturn: is an
  40 // exception to this rule; there really is no other way to deal with dialogs
  41 // since they work with callbacks, so we cannot wait for them to return.)
  42 //
  43 // Be careful with messages with return type other than 'oneway void' -- there
  44 // is a reply timeout set in MMAppController, if a message fails to get a
  45 // response within the given timeout an exception will be thrown.  Use
  46 // @try/@catch/@finally to deal with timeouts.
  47 //
  48 @protocol MMBackendProtocol
  49 - (oneway void)processInput:(int)msgid data:(in bycopy NSData *)data;
  50 - (oneway void)setDialogReturn:(in bycopy id)obj;
  51 - (NSString *)evaluateExpression:(in bycopy NSString *)expr;
  52 - (id)evaluateExpressionCocoa:(in bycopy NSString *)expr
  53                   errorString:(out bycopy NSString **)errstr;
  54 - (BOOL)starRegisterToPasteboard:(byref NSPasteboard *)pboard;
  55 - (oneway void)acknowledgeConnection;
  56 @end
  57
  58
  59 //
  60 // This is the protocol MMAppController implements.
  61 //
  62 // It handles connections between MacVim and Vim and communication from Vim to
  63 // MacVim.
  64 //
  65 // Do not add methods to this interface without a _very_ good reason (if
  66 // possible, instead add a new message to the *MsgID enum below and pass it via
  67 // processInput:forIdentifier).  Methods should not modify the state directly
  68 // but should instead delay any potential modifications (see
  69 // connectBackend:pid: and processInput:forIdentifier:).
  70 //
  71 @protocol MMAppProtocol
  72 - (unsigned)connectBackend:(byref in id <MMBackendProtocol>)proxy pid:(int)pid;
  73 - (oneway void)processInput:(in bycopy NSArray *)queue
  74               forIdentifier:(unsigned)identifier;
  75 - (NSArray *)serverList;
  76 @end
  77
  78
  79 @protocol MMVimServerProtocol;
  80
  81 //
  82 // The Vim client protocol (implemented by MMBackend).
  83 //
  84 // The client needs to keep track of server replies.  Take a look at MMBackend
  85 // if you want to implement this protocol in another program.
  86 //
  87 @protocol MMVimClientProtocol
  88 - (oneway void)addReply:(in bycopy NSString *)reply
  89                  server:(in byref id <MMVimServerProtocol>)server;
  90 @end
  91
  92
  93 //
  94 // The Vim server protocol (implemented by MMBackend).
  95 //
  96 // Note that addInput:client: is not asynchronous, because otherwise Vim might
  97 // quit before the message has been passed (e.g. if --remote was used on the
  98 // command line).
  99 //
 100 @protocol MMVimServerProtocol
 101 - (void)addInput:(in bycopy NSString *)input
 102                  client:(in byref id <MMVimClientProtocol>)client;
 103 - (NSString *)evaluateExpression:(in bycopy NSString *)expr
 104                  client:(in byref id <MMVimClientProtocol>)client;
 105 @end
 106
 107
 108
 109 //
 110 // The following enum lists all messages that are passed between MacVim and
 111 // Vim.  These can be sent in processInput:data: and in processCommandQueue:.
 112 //
 113
 114 // NOTE! This array must be updated whenever the enum below changes!
 115 extern char *MessageStrings[];
 116
 117 enum {
 118     OpenWindowMsgID = 1,    // NOTE: FIRST IN ENUM MUST BE 1
 119     KeyDownMsgID,
 120     BatchDrawMsgID,
 121     SelectTabMsgID,
 122     CloseTabMsgID,
 123     AddNewTabMsgID,
 124     DraggedTabMsgID,
 125     UpdateTabBarMsgID,
 126     ShowTabBarMsgID,
 127     HideTabBarMsgID,
 128     SetTextRowsMsgID,
 129     SetTextColumnsMsgID,
 130     SetTextDimensionsMsgID,
 131     LiveResizeMsgID,
 132     SetTextDimensionsReplyMsgID,
 133     SetWindowTitleMsgID,
 134     ScrollWheelMsgID,
 135     MouseDownMsgID,
 136     MouseUpMsgID,
 137     MouseDraggedMsgID,
 138     FlushQueueMsgID,
 139     AddMenuMsgID,
 140     AddMenuItemMsgID,
 141     RemoveMenuItemMsgID,
 142     EnableMenuItemMsgID,
 143     ExecuteMenuMsgID,
 144     ShowToolbarMsgID,
 145     ToggleToolbarMsgID,
 146     CreateScrollbarMsgID,
 147     DestroyScrollbarMsgID,
 148     ShowScrollbarMsgID,
 149     SetScrollbarPositionMsgID,
 150     SetScrollbarThumbMsgID,
 151     ScrollbarEventMsgID,
 152     SetFontMsgID,
 153     SetWideFontMsgID,
 154     VimShouldCloseMsgID,
 155     SetDefaultColorsMsgID,
 156     ExecuteActionMsgID,
 157     DropFilesMsgID,
 158     DropStringMsgID,
 159     ShowPopupMenuMsgID,
 160     GotFocusMsgID,
 161     LostFocusMsgID,
 162     MouseMovedMsgID,
 163     SetMouseShapeMsgID,
 164     AdjustLinespaceMsgID,
 165     ActivateMsgID,
 166     SetServerNameMsgID,
 167     EnterFullscreenMsgID,
 168     LeaveFullscreenMsgID,
 169     BuffersNotModifiedMsgID,
 170     BuffersModifiedMsgID,
 171     AddInputMsgID,
 172     SetPreEditPositionMsgID,
 173     TerminateNowMsgID,
 174     XcodeModMsgID,
 175     EnableAntialiasMsgID,
 176     DisableAntialiasMsgID,
 177     SetVimStateMsgID,
 178     SetDocumentFilenameMsgID,
 179     OpenWithArgumentsMsgID,
 180     CloseWindowMsgID,
 181     SetFullscreenColorMsgID,
 182     ShowFindReplaceDialogMsgID,
 183     FindReplaceMsgID,
 184     ActivateKeyScriptMsgID,
 185     DeactivateKeyScriptMsgID,
 186     EnableImControlMsgID,
 187     DisableImControlMsgID,
 188     ActivatedImMsgID,
 189     DeactivatedImMsgID,
 190     BrowseForFileMsgID,
 191     ShowDialogMsgID,
 192     NetBeansMsgID,
 193     SetMarkedTextMsgID,
 194     LastMsgID   // NOTE: MUST BE LAST MESSAGE IN ENUM!
 195 };
 196
 197
 198 #define DRAW_WIDE   0x40    /* draw wide text */
 199
 200 enum {
 201     ClearAllDrawType = 1,
 202     ClearBlockDrawType,
 203     DeleteLinesDrawType,
 204     DrawStringDrawType,
 205     InsertLinesDrawType,
 206     DrawCursorDrawType,
 207     SetCursorPosDrawType,
 208     DrawInvertedRectDrawType,
 209 };
 210
 211 enum {
 212     MMInsertionPointBlock,
 213     MMInsertionPointHorizontal,
 214     MMInsertionPointVertical,
 215     MMInsertionPointHollow,
 216     MMInsertionPointVerticalRight,
 217 };
 218
 219
 220 enum {
 221     ToolbarLabelFlag = 1,
 222     ToolbarIconFlag = 2,
 223     ToolbarSizeRegularFlag = 4
 224 };
 225
 226
 227 enum {
 228     MMTabLabel = 0,
 229     MMTabToolTip,
 230     MMTabInfoCount
 231 };
 232
 233
 234 // Create a string holding the labels of all messages in message queue for
 235 // debugging purposes (condense some messages since there may typically be LOTS
 236 // of them on a queue).
 237 NSString *debugStringForMessageQueue(NSArray *queue);
 238
 239
 240 // Shared user defaults (most user defaults are in Miscellaneous.h).
 241 // Contrary to the user defaults in Miscellaneous.h these defaults are not
 242 // intitialized to any default values.  That is, unless the user sets them
 243 // these keys will not be present in the user default database.
 244 extern NSString *MMLogLevelKey;
 245 extern NSString *MMLogToStdErrKey;
 246
 247 // Argument used to stop MacVim from opening an empty window on startup
 248 // (techincally this is a user default but should not be used as such).
 249 extern NSString *MMNoWindowKey;
 250
 251 extern NSString *MMAutosaveRowsKey;
 252 extern NSString *MMAutosaveColumnsKey;
 253
 254
 255 // Vim pasteboard type (holds motion type + string)
 256 extern NSString *VimPBoardType;
 257
 258
 259
 260
 261 @interface NSString (MMExtras)
 262 - (NSString *)stringByEscapingSpecialFilenameCharacters;
 263 @end
 264
 265
 266 @interface NSColor (MMExtras)
 267 + (NSColor *)colorWithRgbInt:(unsigned)rgb;
 268 + (NSColor *)colorWithArgbInt:(unsigned)argb;
 269 @end
 270
 271
 272 @interface NSDictionary (MMExtras)
 273 + (id)dictionaryWithData:(NSData *)data;
 274 - (NSData *)dictionaryAsData;
 275 @end
 276
 277 @interface NSMutableDictionary (MMExtras)
 278 + (id)dictionaryWithData:(NSData *)data;
 279 @end
 280
 281
 282
 283
 284 // ODB Editor Suite Constants (taken from ODBEditorSuite.h)
 285 #define keyFileSender           'FSnd'
 286 #define keyFileSenderToken      'FTok'
 287 #define keyFileCustomPath       'Burl'
 288 #define kODBEditorSuite         'R*ch'
 289 #define kAEModifiedFile         'FMod'
 290 #define keyNewLocation          'New?'
 291 #define kAEClosedFile           'FCls'
 292 #define keySenderToken          'Tokn'
 293
 294
 295 // MacVim Apple Event Constants
 296 #define keyMMUntitledWindow       'MMuw'
 297
 298
 299
 300
 301 #if MAC_OS_X_VERSION_MAX_ALLOWED <= MAC_OS_X_VERSION_10_4
 302 // NSInteger was introduced in 10.5
 303 # if __LP64__ || NS_BUILD_32_LIKE_64
 304 typedef long NSInteger;
 305 typedef unsigned long NSUInteger;
 306 # else
 307 typedef int NSInteger;
 308 typedef unsigned int NSUInteger;
 309 # endif
 310 #endif
 311
 312 #ifndef NSAppKitVersionNumber10_4  // Needed for pre-10.5 SDK
 313 # define NSAppKitVersionNumber10_4 824
 314 #endif
 315
 316
 317 // Logging related functions and macros.
 318 //
 319 // This is a very simplistic logging facility built on top of ASL.  Two user
 320 // defaults allow for changing the local log filter level (MMLogLevel) and
 321 // whether logs should be sent to stderr (MMLogToStdErr).  (These user defaults
 322 // are only checked during startup.)  The default is to block level 6 (info)
 323 // and 7 (debug) logs and _not_ to send logs to stderr.  Apart from this
 324 // "syslog" (see "man syslog") can be used to modify the ASL filters (it is
 325 // currently not possible to change the local filter at runtime).  For example:
 326 //   Enable all logs to reach the ASL database (by default 'debug' and 'info'
 327 //   are filtered out, see "man syslogd"):
 328 //     $ sudo syslog -c syslogd -d
 329 //   Reset the ASL database filter:
 330 //     $ sudo syslog -c syslogd off
 331 //   Change the master filter to block logs less severe than errors:
 332 //     $ sudo syslog -c 0 -e
 333 //   Change per-process filter for running MacVim process to block logs less
 334 //   severe than warnings:
 335 //     $ syslog -c MacVim -w
 336 //
 337 // Note that there are four ASL filters:
 338 //   1) The ASL database filter (syslog -c syslogd ...)
 339 //   2) The master filter (syslog -c 0 ...)
 340 //   3) The per-process filter (syslog -c PID ...)
 341 //   4) The local filter (MMLogLevel)
 342 //
 343 // To view the logs, either use "Console.app" or the "syslog" command:
 344 //   $ syslog -w | grep Vim
 345 // To get the logs to show up in Xcode enable the MMLogToStdErr user default.
 346
 347 extern int ASLogLevel;
 348
 349 void ASLInit();
 350
 351 #define ASLog(level, fmt, ...) \
 352     if (level <= ASLogLevel) { \
 353         asl_log(NULL, NULL, level, "%s@%d: %s", \
 354             __PRETTY_FUNCTION__, __LINE__, \
 355             [[NSString stringWithFormat:fmt, ##__VA_ARGS__] UTF8String]); \
 356     }
 357
 358 // Note: These macros are used like ASLogErr(@"text num=%d", 42).  Objective-C
 359 // style specifiers (%@) are supported.
 360 #define ASLogCrit(fmt, ...)   ASLog(ASL_LEVEL_CRIT,    fmt, ##__VA_ARGS__)
 361 #define ASLogErr(fmt, ...)    ASLog(ASL_LEVEL_ERR,     fmt, ##__VA_ARGS__)
 362 #define ASLogWarn(fmt, ...)   ASLog(ASL_LEVEL_WARNING, fmt, ##__VA_ARGS__)
 363 #define ASLogNotice(fmt, ...) ASLog(ASL_LEVEL_NOTICE,  fmt, ##__VA_ARGS__)
 364 #define ASLogInfo(fmt, ...)   ASLog(ASL_LEVEL_INFO,    fmt, ##__VA_ARGS__)
 365 #define ASLogDebug(fmt, ...)  ASLog(ASL_LEVEL_DEBUG,   fmt, ##__VA_ARGS__)
 366 #define ASLogTmp(fmt, ...)    ASLog(ASL_LEVEL_NOTICE,  fmt, ##__VA_ARGS__)