/*
 * TRConfigToken.h vi:ts=4:sw=4:expandtab:
 * Configuration Lexer Tokens
 *
 * Author: Landon Fuller <landonf@threerings.net>
 *
 * Copyright (c) 2006 - 2007 Three Rings Design, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holder nor the names of any contributors
 *    may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifdef HAVE_CONFIG_H
#import <config.h>
#endif

#import <stdlib.h>

#import "TRObject.h"
#import "TRString.h"

/**
 * Object Data Types.
 * Tokens are always strings (TOKEN_DATATYPE_STRING),
 * but sometimes they can also be integers and booleans.
 * In other words, the integer and boolean datatypes should
 * be considered to provide a superset of functionality to the
 * string data type.
 */
typedef enum {
    TOKEN_DATATYPE_STRING,
    TOKEN_DATATYPE_INT,
    TOKEN_DATATYPE_BOOL
} TRConfigDataType;

@interface TRConfigToken : TRObject {
@private
    /* Parser's token identifier */
    int _tokenID;

    /* Token's line origin */
    unsigned int _lineNumber;

    /* String value */
    TRString *_string;

    /* Current data type */
    TRConfigDataType _dataType;

    /* Union of internal representations */
    union {
        int _intValue;
        BOOL _boolValue;
    } _internalRep;
}

- (id) initWithBytes: (const char *) data numBytes: (size_t) length lineNumber: (unsigned int) line tokenID: (int) tokenID;

- (int) tokenID;
- (unsigned int) lineNumber;

- (TRString *) string;
- (const char *) cString;
- (BOOL) intValue: (int *) value;
- (BOOL) boolValue: (BOOL *) value;

@end
