LOButtonTokeniser.h

00001 /*
00002  *
00003  * Copyright (c) 2006,2005,2004 Ben Suffolk <ben@usbdmx.com>
00004  * All rights reserved.
00005  *
00006  * Redistribution and use in source and binary forms, with or without 
00007  * modification, are permitted provided that the following conditions are met:
00008  *
00009  * 1. Redistributions of source code must retain the above copyright notice,
00010  *    this list of conditions and the following disclaimer.
00011  *
00012  * 2. Redistributions in binary form must reproduce the above copyright notice,
00013  *    this list of conditions and the following disclaimer in the documentation
00014  *    and/or other materials provided with the distribution.
00015  *
00016  * 3. Neither the name of the usbdmx.com web site nor the names of its 
00017  *    contributors may be used to endorse or promote products derived from this
00018  *    software without specific prior written permission.
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
00021  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
00022  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
00023  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
00024  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
00025  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
00026  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
00027  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
00028  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
00029  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00030  * POSSIBILITY OF SUCH DAMAGE.
00031  *
00032  * $Id: LOButtonTokeniser.h 241 2009-10-23 16:27:41Z ben.suffolk $
00033  *
00034  *******************************************************************************
00035  *
00036  * History :-
00037  *
00038  * <Name>  <Date>
00039  *
00040  * <Comment>
00041  * 
00042  *******************************************************************************
00043 */
00044 
00045 
00046 
00047 #import <Cocoa/Cocoa.h>
00048 @class LOCommandProcessor;
00049 @class LOCommandToken;
00050 
00051 
00061 @interface LOButtonTokeniser : NSObject
00062 {
00063  LOCommandProcessor *commandProcessor;
00064  NSMutableArray *tokens;
00065 }
00066 
00067 
00085 - (BOOL)addToken:(LOCommandToken *)token;
00086 
00087 
00110 - (BOOL)digit:(unsigned)theDigit;
00111 
00112 
00120 - (BOOL)dotButton;
00121 
00122 
00143 - (BOOL)plus;
00144 
00145 
00166 - (BOOL)minus;
00167 
00168 
00189 - (BOOL)thru;
00190 
00191 
00212 - (BOOL)at;
00213 
00214 
00235 - (BOOL)on;
00236 
00237 
00258 - (BOOL)off;
00259 
00260 
00281 - (BOOL)solo;
00282 
00283 
00304 - (BOOL)releaseButton;
00305 
00306 
00317 - (BOOL)lastButton;
00318 
00319 
00334 - (BOOL)enter;
00335 
00336 
00342 - (void)clear;
00343 
00344 
00352 - (BOOL)backSpace;
00353 
00354 
00361 - (BOOL)checkTokens;
00362 
00363 
00371 - (NSArray *)tokeniseCommand;
00372 
00373 
00380 - (BOOL)submitCommand;
00381 
00382 
00388 - (NSString *)currentCommandString;
00389 
00390 
00396 - (LOCommandProcessor *)commandProcessor;
00397 
00398 @end
00399 
00400 
00401 
00402 
00403 
00404 
00405 
00406 
00407 
00408