CnDebugger接口帮助文档.docVIP

CnDebugger接口帮助文档 作者：Blue++(zy_hon@) 刘啸(liuxiao@) 部门：CnPack开发组 类别：帮助文档 版本：V 创建：2006.09.05 修改：2008.05.01 引 言 CnDebugger概述 CnDebugger是CnPack开发组为Windows平台上的Delphi/C++Builder开发者提供的一套简要的调试信息记录工具的统称，包括接口单元和外部信息查看控制工具两大方面的内容。另外也指CnDebug单元中的调试对象名称。 CnDebugger的输出调试信息能进行分类过滤，可包含四种过滤条件：文字、层次、类型和标签等。此外，CnDebugger还提供异常过滤以及输出信息统计等功能。 CnDebugger的每条输出信息中并不只是简单地包含一字符串，而是包括了以下可自定义的多种内容： 文字：Msg，字符串格式，最大长度有限制。 层次：Level，一整数，作为过滤条件之用。用户可自定义某条输出信息的Level。Level按层次包容，譬如如果指定了内部过滤条件中的Level为2，那么小于等于2的Level的信息都能被输出，大于2的则被屏蔽了。目前Level定为0到3。默认是3，也就是全部输出。所以Level可以用来控制输出信息的详细程度。 类型：MsgType，标识该信息的类型，是普通信息还是警告还是错误等。 标签：Tag，固定长度的字符串格式（目前最长8字节），用于单项过滤之用。输出时如不指定，默认是空。 接收端可根据这些信息进行方便的分类显示过滤处理。 CnDebugger对象正常情况下在CnDebug.pas单元initialization时创建，在finalization时释放CnPropSheetFrm.pas来参与编译。 在C++Builder中使用CnDebug.pas 在 C++Builder使用CnDebug.pas也比较简单，只需要将CnDebug.pas加入工程，然后在需要使用的单元头部#include “CnDebug.hpp”即可，程序中可通过CnDebugger()-TraceMsg(“AMsg”);等方式来输出信息了（hpp文件会自动生成）。 查看CnDebug.pas输出的内容 CnDebug.pas输出的内容需要用CnDebugViewer来查看。一般可先运行CnDebugViewer，然后再运行了包含CnDebug.pas的程序，CnDebugViewer便会自动读取记录并显示输出内容。 关于CnDebugViewer的更多内容请参考CnWizards的帮助文档中的CnDebugger部分。 CnDebugger CnDebugger对象功能概述 CnDebugger对象提供了多个记录不同数据类型的记录函数如LogMsg、LogMsgWarning、LogColor、LogStrings等，而且还提供了LogEnter/TraceEnter、LogLeave/TraceLeave等函数来标识进入或退出过程的记录，并能自动转换整数、浮点数、颜色值，并且能用RTTI来处理对象与组件以生成输出的属性总结、拦截Exception发生时的现场信息记录等。 基本用法：一般在implementation处uses CnDebug单元并在Project Options中Conditional Defines里设置DEBUG条件，然后在需要的地方使用CnDebugger对象的Log/Trace等方法来输出必要的信息。 CnDebugger 提供两类输出接口：Log系列和Trace系列。两类输出接口基本上具有相同的参数和功能。所不同的在于，Log系列功能只在DEBUG编译条件被定义的时候有效，而Trace系列在普通情况下也有效。不过在NDEBUG定义的情况下两者都无效。 以上写成表达式就是： Log 有效 := IFNDEF NDEBUG and IFDEF DEBUG Trace 有效 := IFNDEF NDEBUG Log系列输出接口仅在调试时DEBUG被定义的情况下参与编译，适合用于产生比较详细的记录的场合；而Trace系列输出接口在正式版发布时默认也会被编译入产品中，用于产生关键的调试记录。同时，这两类功能可在NDEBUG情况下方便地被全部禁用。 CnDebug.pas还提供了在运行期弹出窗体显示一对象RTTI信息的功能，此功能需定义SUPPORT_EVALUATE。和上面类似，SUPPORT_EVALUATE也会在NDEBUG已被定义的情况下被UNDEF而无效。 另外CnDebug.pas的输出信息在输出时可同时记录到文件，此功能需定义DUMP_TO_FILE，默认的输出文件名是和应用程序所在文件同一目录下的“CnDe