rickg 5205f5daea improved documentation in headers
git-svn-id: svn://10.0.0.236/trunk@304 18797224-902f-48f8-a5cc-f745e15eee43
1998-04-15 17:27:56 +00:00

156 lines
4.9 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/*
* The contents of this file are subject to the Netscape Public License
* Version 1.0 (the "NPL"); you may not use this file except in
* compliance with the NPL. You may obtain a copy of the NPL at
* http://www.mozilla.org/NPL/
*
* Software distributed under the NPL is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
* for the specific language governing rights and limitations under the
* NPL.
*
* The Initial Developer of this code under the NPL is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
* Reserved.
*/
#include "nsToken.h"
#include "nsScanner.h"
/**-------------------------------------------------------
* Default constructor
*
* @update gess 3/25/98
* @param nsString--name of token
*------------------------------------------------------*/
CToken::CToken(const nsString& aName) : mTextValue(aName) {
mOrdinalValue=0;
}
/**-------------------------------------------------------
* Decstructor
*
* @update gess 3/25/98
*------------------------------------------------------*/
CToken::~CToken() {
}
/**-------------------------------------------------------
* Virtual method used to tell this toke to consume his
* valid chars.
*
* @update gess 3/25/98
* @param aChar -- first char in sequence
* @param aScanner -- object to retrieve data from
* @return int error code
*------------------------------------------------------*/
PRInt32 CToken::Consume(PRUnichar aChar,CScanner* aScanner) {
PRInt32 result=kNoError;
return result;
}
/**-------------------------------------------------------
* Method used to set the string value of this token
*
* @update gess 3/25/98
* @param aValue -- char* containing new value
*------------------------------------------------------*/
void CToken::SetStringValue(const char* aValue) {
mTextValue=aValue;
}
/**-------------------------------------------------------
* This debug method causes the token to dump its content
* to the given stream (formated for debugging).
*
* @update gess 3/25/98
* @param ostream -- output stream to accept output data
*------------------------------------------------------*/
void CToken::DebugDumpToken(ostream& anOutputStream) {
anOutputStream << "[" << GetClassName() << "] ";
for(int i=0;i<mTextValue.Length();i++){
anOutputStream << char(mTextValue[i]);
}
anOutputStream << ": " << mOrdinalValue << endl;
}
/**-------------------------------------------------------
* This debug method causes the token to dump its content
* to the given stream, formated as text.
*
* @update gess 3/25/98
* @param ostream -- output stream to accept output data
*------------------------------------------------------*/
void CToken::DebugDumpSource(ostream& anOutputStream) {
anOutputStream << mTextValue;
}
/**-------------------------------------------------------
* This method retrieves the value of this internal string.
*
* @update gess 3/25/98
* @return nsString reference to internal string value
*------------------------------------------------------*/
nsString& CToken::GetStringValue(void) {
return mTextValue;
}
nsString& CToken::GetText(void) {
return mTextValue;
}
/**-------------------------------------------------------
* Sets the internal ordinal value for this token.
* This method is deprecated, and will soon be going away.
*
* @update gess 3/25/98
* @param value -- new ordinal value for this token
*------------------------------------------------------*/
void CToken::SetOrdinal(PRInt32 value) {
mOrdinalValue=value;
}
/**-------------------------------------------------------
* Retrieves copy of internal ordinal value.
* This method is deprecated, and will soon be going away.
*
* @update gess 3/25/98
* @return int containing ordinal value
*------------------------------------------------------*/
PRInt32 CToken::GetOrdinal(void) {
return mOrdinalValue;
}
/**-------------------------------------------------------
* Retrieve type of token. This class returns -1, but
* subclasses return something more meaningful.
*
* @update gess 3/25/98
* @return int value containing token type.
*------------------------------------------------------*/
PRInt32 CToken::GetTokenType(void) {
return -1;
}
/**-------------------------------------------------------
* retrieve this tokens classname.
*
* @update gess 3/25/98
* @return char* containing name of class
*------------------------------------------------------*/
const char* CToken::GetClassName(void) {
return "token";
}
/**-------------------------------------------------------
*
* @update gess 3/25/98
*------------------------------------------------------*/
void CToken::SelfTest(void) {
#ifdef _DEBUG
#endif
}