identifiers.h

这是一个能够自动生成文档的程序

#ifndef __IDENTIFIERS_H__
#define __IDENTIFIERS_H__
#pragma once

#include "Macro.h"
#include "IdenItem.h"

#include <afxtempl.h>
typedef CMap<CString, LPCTSTR, CIdenItem*, CIdenItem*> CIdenMap;


//管理符号表，所有需要用于符号查询的符号均统一保存在此类的对象中，
//以便一次性查询，包括：
//1. 关键字，包括基本数据类型
//2. 宏扩展，在完成预处理后删除
//3. enum
//4. 类，结构，接口
//5. 函数：包括所有函数
//6. 变量：包括全局变量和类成员变量
//所有符号首先保存到CIdneItem类的对象中，然后将其对象指针保存到列表中
class CIdentifiers  
{
public:
	//构造函数
	CIdentifiers();
	//析构函数
	virtual ~CIdentifiers();
	//初始化，在解析一个项目的代码前，要首先将符号表初始化
	void Init();
	//清除全部标识符
	void ClearContent();

public:
	//加入Item，函数一用于加入关键字、宏定义等没有域限制的标识符
    //函数二用于加入类，函数，变量等有域限制的标识符
	//其中，变量和函数均可以声明和定义分另加入，加入时合并
	//函数还可以加入重载函数，加入时合并
	//返回TRUE表示普通加入，参数中的ipIden指针仍然是有效指针
	//返回FALSE表示合并加入，参数中的ipIden指针所指对象已被删除
	BOOL AddIdentifier(LPCTSTR iName, UINT iType=ID_UNDEFINED, 
		CIdentifier* ipIden=NULL, KEYWORD iKeyIndex=KEY_NOT);
	BOOL AddIdentifier(LPCTSTR iName, UINT iType, CIdentifier* ipIden, LPCTSTR iScope);

	//根据名称删除一个标识符
	void DeleteIdentifier(LPCTSTR iName);
	//设定全局宏，多个宏用;分隔
	void AddGlobalMacro(LPCTSTR iMacros);

    //查询标识符是否关键字，是则返回关键字编号，否则返回KEY_NOT
	KEYWORD QueryKeyword(LPCTSTR);
	//查询标识符是否是已定义的宏
	BOOL IsDefinedMacro(LPCTSTR iName, CPage* ipPage=NULL);
	//判断标识符是否是宏，如是，则展开，即将宏名删除，替换为展开后的Token，返回Item指针。
	//对于其他标识符，返回Item指针。未定义的标识符返回NULL
	//iWord为标识符，ipPage为标识符所在的代码页
	CIdenItem* UnwindMacro(LPCTSTR iWord, CPage* ipPage,
		CTokenList& ioList, POSITION& ioPos);
    //查询一个标识符项，如不存在，返回NULL
	CIdenItem* Search(LPCTSTR iName);


private:
	CIdenMap  mMap;  //标识符映射表
    


	UNIT_TEST(CIdentifiers)
};

#endif