7

我有一个主要用 C# 编写的项目。我需要为这个项目的 API 的所有错误号“定义”定义一个类。我试图避免编写/更改我的许多代码生成器之一来实现这一点。

我想做的是能够将#include内容(如错误文件)直接放入 C/C++ 项目中。我在 C# 中对它们进行了如下定义,并且我没有对您将在此处看到的内容使用枚举:

using System;

namespace ProjectAPI {

[Serializable]
public sealed class ProjectError {

    public enum ProjectErrorClass {
        None            = -1,
        Undefined       = 0,
        Login,
        Store,
        Transaction,
        Heartbeat,
        Service,
        HTTPS,
        Uploader,
        Downloader,
        APICall,
        AutoUpdate,
        General
    }

    public enum ProjectErrorLevel {
        Unknown = -1,
        Success = 0,
        Informational,
        Warning,
        Critical,
    };

    /// <summary>
    /// PROJECT_ERROR_BASE - This is the base for all Project defined errors in the API.  Project Errors are defined as follows:
    ///   ProjectAPI error values are 32 bit values defined as follows:
    ///   3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1
    ///   1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
    ///  +---+---------------+-----------------------+------------------+
    ///  |Sev|Error Code Base| Error Class           |Unique Error Code |
    ///  +---+---------------+-----------------------+------------------+
    ///  where
    ///
    ///      Sev - is the severity code of the error (2 bits), and is defined as follows:
    ///          00 - Success (non-fatal)   0x00
    ///          01 - Informational         0x01
    ///          10 - Warning               0x02
    ///          11 - Error                 0x03
    ///
    ///      Error Code Base - is the starting point of all Project Errors, and is set at 0xA4 (8 Bits).
    ///
    ///      Error Class - is the error class, or API "Module" that caused the error (12 bits).
    ///
    ///      Code - the unique error code (10 bits). (0 - 1,023 (0x3FF)).
    /// </summary>

    private static readonly int ERR_SHIFT                       = 0x1E;
    private static readonly int BASE_SHIFT                      = 0x16;
    private static readonly int CLASS_SHIFT                     = 0x06;

    private static readonly int PROJECT_SEV_SUCCESS           = 0x00;
    private static readonly int PROJECT_SEV_INFO              = 0x01;
    private static readonly int PROJECT_SEV_WARN              = 0x02;
    private static readonly int PROJECT_SEV_ERROR             = 0x03;

    private static readonly int PROJECT_ERROR_BASE             = 0xA5;

    /// <summary>
    /// Project Error Class Constants:
    /// </summary>
    private static readonly int PROJECT_ERROR_CLASS_UNDEF     = 0x0010;   /// Undefined.
    private static readonly int PROJECT_ERROR_CLASS_LOGIN     = 0x0020;   /// LoginClass Error.
    private static readonly int PROJECT_ERROR_CLASS_STORE     = 0x0040;   /// Store Error.
    private static readonly int PROJECT_ERROR_CLASS_TRANS     = 0x0080;   /// Transaction Error.
    private static readonly int PROJECT_ERROR_CLASS_HEART     = 0x0100;   /// HeartBeat (Project Health Monitor) Error.
    private static readonly int PROJECT_ERROR_CLASS_SERV      = 0x0200;   /// Service Error.
    private static readonly int PROJECT_ERROR_CLASS_HTTP      = 0x0400;   /// HTTP/HTTPS Error.
    private static readonly int PROJECT_ERROR_CLASS_UPLOAD    = 0x0800;   /// Upload (Transactions) Error
    private static readonly int PROJECT_ERROR_CLASS_DOWNLOAD  = 0x1000;   /// Download (Transactions) Error
    private static readonly int PROJECT_ERROR_CLASS_APICALL   = 0x2000;   /// API Command/call error.
    private static readonly int PROJECT_ERROR_CLASS_UPDATE    = 0x4000;   /// Auto-Updater Errors.
    private static readonly int PROJECT_ERROR_CLASS_GEN       = 0x8000;   /// General Error.

    public static readonly int PROJECT_ERROR_UNKNOWN_ERROR    = ProjectErrCode(PROJECT_SEV_ERROR, PROJECT_ERROR_CLASS_GEN, 0x001);
    // Was...
    //    (((PROJECT_SEV_ERROR << ERR_SHIFT) | PROJECT_ERROR_BASE << BASE_SHIFT) | ((PROJECT_ERROR_CLASS_UNDEF << CLASS_SHIFT) | 0x0001));

    public static readonly int PROJECT_ERROR_UNKNOWN_HEARTBEAT_ERROR = ProjectErrCode(PROJECT_SEV_ERROR, PROJECT_ERROR_CLASS_HEART, 0x001);
...Snip...

...

我意识到我可以在 Enums 中添加其他东西,但是我的目标是也能够使用 C++ 编译器编译这个源代码。(上面的示例中缺少一些函数,即ProjectErrCode()从 API 调用时构建错误代码 OTF 的最终整数值的函数。)

我正在构建评论中看到的错误常量,我可以回到那个,但我宁愿编写类似的类——一个在 C# 中,一个在 C++ 中,可以构造/解构错误代码。我的函数返回错误的严重性、错误类等。开发人员可以忽略它、记录它、将它传递给 UI 等。

如果我只有 5 或 10 个错误代码,这将不是问题。但我有超过 100 个,真的不想维护一个包含重复信息的 .cs 和 .h 文件。我可以在 .h 文件中管理它们并让 CS 代码读取它们,但这几乎与编写(修改)代码生成器一样多。


我怎样才能#define获得单个源文件,以便 C# 编译器可以编译它,就像 C/++ 编译器一样?我可以简单地#include "ProjectErrors.cs"- 文件名在那里不是问题。我开始认为我可以通过#define'ing 之类的东西来做到这一点,using System;但几乎被挂在那里。

4

2 回答 2

4

一种选择是使用T4:这是一种内置于 Visual Studio 中的代码生成语言。它主要用于 C#,但C++ 显然也可以工作

预处理器难以使用的原因之一是 C# 和 C++ 具有相同的注释语法:您将无法使用注释隐藏 C++ 预处理器的不兼容 C# 特定语法。也就是说,您可以尝试 VB :)。

于 2013-11-11T20:58:09.323 回答
4

1)使用预处理器。一些 ifdef 和定义应该可以解决问题,但它会非常混乱。

2) 使用 C++/CLI。C++/CLI 是 C++ 的变体,被编译成 .Net 程序集。虽然 .Net 类型和本机类型是独立的实体,但它们之间的转换是可能的。

例如,您将标头定义为具有本机枚举和常量的完全本机代码;然后,您可以将此标头包含到 100% 本机项目和 C++/CLI 项目中,这还将提供枚举到相应 .Net 类型的转换(参见此线程)。

如果您不希望有这个中间转换层,C++/CLI 还为您提供了 C++ 宏的全部功能,因此您可以使用 ENUM_HEADER 和 CONSTANT 等宏创建一个文件,并公平地将它们评估为适当的托管或本机形式干净和直接的方式(你不能用 C# 做,因为它的预处理器要弱得多)。生成的程序集本质上就是这个头文件和适当的宏定义,仅此而已。

3) 在一些外部文件(XML、INI 等)中定义值,并且只在 C# 和 C++ 中实现加载逻辑(这实际上可能是最干净的解决方案)。

于 2013-11-11T20:32:47.530 回答