C ++: stampa il valore enum come testo

89

Se ho un'enumerazione come questa

enum Errors
{ErrorA=0, ErrorB, ErrorC};

Quindi voglio stampare su console

Errors anError = ErrorA;
cout<<anError;/// 0 will be printed

ma quello che voglio è il testo "ErrorA", posso farlo senza usare if / switch?
E qual è la tua soluzione per questo?

c++  enums 
— tiboo
fonte
Penso che la mia risposta sia abbastanza buona, ti dispiacerebbe dare un'occhiata?
— Xiao
2
— Ciro Santilli郝海东冠状病六四事件法轮功
2
— Ciro Santilli郝海东冠状病六四事件法轮功

Risposte:

63

Utilizzando la mappa:

#include <iostream>
#include <map>
#include <string>

enum Errors {ErrorA=0, ErrorB, ErrorC};

std::ostream& operator<<(std::ostream& out, const Errors value){
    static std::map<Errors, std::string> strings;
    if (strings.size() == 0){
#define INSERT_ELEMENT(p) strings[p] = #p
        INSERT_ELEMENT(ErrorA);     
        INSERT_ELEMENT(ErrorB);     
        INSERT_ELEMENT(ErrorC);             
#undef INSERT_ELEMENT
    }   

    return out << strings[value];
}

int main(int argc, char** argv){
    std::cout << ErrorA << std::endl << ErrorB << std::endl << ErrorC << std::endl;
    return 0;   
}

Utilizzo di array di strutture con ricerca lineare:

#include <iostream>
#include <string>

enum Errors {ErrorA=0, ErrorB, ErrorC};

std::ostream& operator<<(std::ostream& out, const Errors value){
#define MAPENTRY(p) {p, #p}
    const struct MapEntry{
        Errors value;
        const char* str;
    } entries[] = {
        MAPENTRY(ErrorA),
        MAPENTRY(ErrorB),
        MAPENTRY(ErrorC),
        {ErrorA, 0}//doesn't matter what is used instead of ErrorA here...
    };
#undef MAPENTRY
    const char* s = 0;
    for (const MapEntry* i = entries; i->str; i++){
        if (i->value == value){
            s = i->str;
            break;
        }
    }

    return out << s;
}

int main(int argc, char** argv){
    std::cout << ErrorA << std::endl << ErrorB << std::endl << ErrorC << std::endl;
    return 0;   
}

Utilizzando interruttore / caso:

#include <iostream>
#include <string>

enum Errors {ErrorA=0, ErrorB, ErrorC};

std::ostream& operator<<(std::ostream& out, const Errors value){
    const char* s = 0;
#define PROCESS_VAL(p) case(p): s = #p; break;
    switch(value){
        PROCESS_VAL(ErrorA);     
        PROCESS_VAL(ErrorB);     
        PROCESS_VAL(ErrorC);
    }
#undef PROCESS_VAL

    return out << s;
}

int main(int argc, char** argv){
    std::cout << ErrorA << std::endl << ErrorB << std::endl << ErrorC << std::endl;
    return 0;   
}
— SigTerm
fonte
12
-1. Basta fare uno switch-case invece di usare una hash-map. Una maggiore complessità non è una buona cosa.
— Simon
8
Buon punto. La prossima volta lo farò :) Ma ora vedo che hai già modificato il tuo post per aggiungere il tipo di funzionalità che stavo cercando. Buon lavoro!
— Simon
1
cos'è #p? se nel terzo esempio invece di enum utilizzo una classe enum, è possibile ottenere solo la stringa enum senza il nome della classe?
— rh0x
2
#pè il preprocessore che stringe p. Quindi chiamando PROCESS_VAL(ErrorA)uscita volontà: case(ErrorA): s = "ErrorA"; break;.
— Nashenas
Non lo considero una soluzione ottimale: Motivi: 1) Devo mantenere il doppio dei enumvalori che penso sia un NO-GO . 2) Quando capisco correttamente la soluzione funziona solo per uno enum.
— Peter VARGA
28

Utilizza un array o un vettore di stringhe con valori corrispondenti:

char *ErrorTypes[] =
{
    "errorA",
    "errorB",
    "errorC"
};

cout << ErrorTypes[anError];

EDIT: La soluzione sopra è applicabile quando l'enum è contiguo, cioè parte da 0 e non ci sono valori assegnati. Funzionerà perfettamente con l'enumerazione nella domanda.

Per dimostrarlo ulteriormente per il caso in cui enum non parte da 0, usa:

cout << ErrorTypes[anError - ErrorA];
— Igor Oks
fonte
4
sfortunatamente, enum ci permette di assegnare valori agli elementi. Come ti avvicini al lavoro se hai enumerazioni non contigue, riga 'enum Status {OK = 0, Fail = -1, OutOfMemory = -2, IOError = -1000, ConversionError = -2000} `` (così puoi aggiungere successivamente IOErrors nell'intervallo -1001-1999)
— Nordic Mainframe
@ Luther: Sì, funzionerà solo con enumerazioni contigue, come la maggior parte delle enumerazioni . Nel caso in cui enum non sia contiguo, sarà necessario utilizzare un altro approccio, ad esempio maps. Ma in caso di enumerazione contigua, suggerirei di utilizzare questo approccio e di non complicare eccessivamente.
— Igor Oks
2
Quindi, se il mio collega aggiunge NewValue a un'enumerazione e non aggiorna l'array ErrorTypes, allora ErrorTypes [NewValue] restituisce cosa? E come gestisco i valori enum negativi?
— Nordic Mainframe
2
@ Luther: dovrai mantenere aggiornati ErrorTypes. Ancora una volta, c'è un compromesso tra semplicità e universalità, dipende da cosa è più importante per l'utente. Qual è il problema con i valori enum negativi?
— Igor Oks
1
Questo array non dovrebbe essere statico per l'efficienza della memoria? e const per la sicurezza?
— Jonathan
15

Ecco un esempio basato su Boost.Preprocessor:

#include <iostream>

#include <boost/preprocessor/punctuation/comma.hpp>
#include <boost/preprocessor/control/iif.hpp>
#include <boost/preprocessor/comparison/equal.hpp>
#include <boost/preprocessor/stringize.hpp>
#include <boost/preprocessor/seq/for_each.hpp>
#include <boost/preprocessor/seq/size.hpp>
#include <boost/preprocessor/seq/seq.hpp>


#define DEFINE_ENUM(name, values)                               \
  enum name {                                                   \
    BOOST_PP_SEQ_FOR_EACH(DEFINE_ENUM_VALUE, , values)          \
  };                                                            \
  inline const char* format_##name(name val) {                  \
    switch (val) {                                              \
      BOOST_PP_SEQ_FOR_EACH(DEFINE_ENUM_FORMAT, , values)       \
    default:                                                    \
        return 0;                                               \
    }                                                           \
  }

#define DEFINE_ENUM_VALUE(r, data, elem)                        \
  BOOST_PP_SEQ_HEAD(elem)                                       \
  BOOST_PP_IIF(BOOST_PP_EQUAL(BOOST_PP_SEQ_SIZE(elem), 2),      \
               = BOOST_PP_SEQ_TAIL(elem), )                     \
  BOOST_PP_COMMA()

#define DEFINE_ENUM_FORMAT(r, data, elem)             \
  case BOOST_PP_SEQ_HEAD(elem):                       \
  return BOOST_PP_STRINGIZE(BOOST_PP_SEQ_HEAD(elem));


DEFINE_ENUM(Errors,
            ((ErrorA)(0))
            ((ErrorB))
            ((ErrorC)))

int main() {
  std::cout << format_Errors(ErrorB) << std::endl;
}
— Philipp
fonte
2
+1, Questa soluzione non si basa su uno strumento esterno, come la risposta lua sopra, ma è puro C ++, segue il principio DRY e la sintassi dell'utente è leggibile (se formattata correttamente. BTW, non sono necessarie le barre rovesciate quando si utilizza DEFINE_ENUM, che sembra un po 'più naturale, IMO)
— Fabio Fracassi
3
@Fabio Fracassi: "Questa soluzione non si basa su uno strumento esterno" Boost è uno strumento esterno - libreria C ++ non standard. Inoltre, è un po 'troppo lungo. La soluzione a un problema dovrebbe essere il più semplice possibile. Questo non si qualifica ...
— SigTerm
2
In realtà è tutto ciò che potresti mettere la maggior parte del codice (in realtà tutto tranne la definizione effettiva) può essere inserito in una singola intestazione. quindi questa è in realtà la soluzione più breve presentata qui. E perché il boost sia esterno, sì, ma meno di uno script fuori linguaggio per preelaborare parti del sorgente come lo è lo script lua sopra. Inoltre boost è così vicino allo standard che dovrebbe essere in ogni toolbox per programmatori C ++. Solo IMHO, ovviamente
— Fabio Fracassi
[Ho rimosso l'escape non necessaria di newline nell'invocazione della macro. Non sono necessari: una chiamata di macro può estendersi su più righe.]
— James McNellis
La macro DEFINE_ENUMmi dà l'errore multiple definition of `format_ProgramStatus(ProgramStatus)'quando provo a usarla.
— Ciao arrivederci
6

È possibile utilizzare un trucco più semplice del pre-processore se si desidera elencare le enumvoci in un file esterno.

/* file: errors.def */
/* syntax: ERROR_DEF(name, value) */
ERROR_DEF(ErrorA, 0x1)
ERROR_DEF(ErrorB, 0x2)
ERROR_DEF(ErrorC, 0x4)

Quindi, in un file sorgente, tratti il ​​file come un file di inclusione, ma definisci cosa vuoi ERROR_DEFche faccia.

enum Errors {
#define ERROR_DEF(x,y) x = y,
#include "errors.def"
#undef ERROR_DEF
};

static inline std::ostream & operator << (std::ostream &o, Errors e) {
    switch (e) {
    #define ERROR_DEF(x,y) case y: return o << #x"[" << y << "]";
    #include "errors.def"
    #undef ERROR_DEF
    default: return o << "unknown[" << e << "]";
    }
}

Se utilizzi uno strumento di navigazione dei sorgenti (come cscope), dovrai informarlo del file esterno.

— jxh
fonte
4

C'è stata una discussione qui che potrebbe aiutare: C'è un modo semplice per convertire l'enumerazione C ++ in stringa?

AGGIORNAMENTO: qui # uno script per Lua che crea un operatore << per ogni enum denominato che incontra. Potrebbe essere necessario un po 'di lavoro per farlo funzionare per i casi meno semplici [1]:

function make_enum_printers(s)
    for n,body in string.gmatch(s,'enum%s+([%w_]+)%s*(%b{})') do
    print('ostream& operator<<(ostream &o,'..n..' n) { switch(n){') 
    for k in string.gmatch(body,"([%w_]+)[^,]*") do
    print('  case '..k..': return o<<"'..k..'";')
    end
    print('  default: return o<<"(invalid value)"; }}')
    end
end

local f=io.open(arg[1],"r")
local s=f:read('*a')
make_enum_printers(s)

Dato questo input:

enum Errors
{ErrorA=0, ErrorB, ErrorC};

enum Sec {
    X=1,Y=X,foo_bar=X+1,Z
};

Produce:

ostream& operator<<(ostream &o,Errors n) { switch(n){
  case ErrorA: return o<<"ErrorA";
  case ErrorB: return o<<"ErrorB";
  case ErrorC: return o<<"ErrorC";
  default: return o<<"(invalid value)"; }}
ostream& operator<<(ostream &o,Sec n) { switch(n){
  case X: return o<<"X";
  case Y: return o<<"Y";
  case foo_bar: return o<<"foo_bar";
  case Z: return o<<"Z";
  default: return o<<"(invalid value)"; }}

Quindi questo è probabilmente un inizio per te.

[1] enumerazioni in ambiti diversi o non dello spazio dei nomi, enumerazioni con espressioni di inizializzazione che contengono un komma, ecc.

— Mainframe nordico
fonte
Non è una consuetudine qui commentare un "-1" per dare al poster l'opportunità di fissare la propria risposta? Chiedo solo ..
— Nordic Mainframe
2
Penso che la soluzione Boost PP di seguito (da Philip) sia migliore, perché l'uso di strumenti esterni è molto costoso in termini di manutenzione. ma no -1 perché la risposta è altrimenti valida
— Fabio Fracassi
4
Il Boost PP è anche un problema di manutenzione, perché è necessario che tutti parlino il metalinguaggio Boost PP, che è terribile , facile da rompere (dando messaggi di errore solitamente inutilizzabili) e solo di usabilità limitata (lua / python / perl può generare codice arbitrario dati esterni). Aggiunge un impulso all'elenco delle dipendenze, che potrebbe non essere nemmeno consentito a causa della politica del progetto. Inoltre, è invasivo perché richiede di definire le enumerazioni in un DSL. Il tuo strumento di codice sorgente preferito o IDE potrebbe avere problemi con questo. E, ultimo ma non meno importante: non è possibile impostare un punto di interruzione nell'espansione.
— Nordic Mainframe
4

Uso un array di stringhe ogni volta che definisco un enum:

Profile.h

#pragma once

struct Profile
{
    enum Value
    {
        Profile1,
        Profile2,
    };

    struct StringValueImplementation
    {
        const wchar_t* operator[](const Profile::Value profile)
        {
            switch (profile)
            {
            case Profile::Profile1: return L"Profile1";
            case Profile::Profile2: return L"Profile2";
            default: ASSERT(false); return NULL;
            }
        }
    };

    static StringValueImplementation StringValue;
};

Profile.cpp

#include "Profile.h"

Profile::StringValueImplementation Profile::StringValue;
— Mark Ingram
fonte
4

Questo è un buon modo

enum Rank { ACE = 1, DEUCE, TREY, FOUR, FIVE, SIX, SEVEN, EIGHT, NINE, TEN, JACK, QUEEN, KING };

Stampalo con un array di array di caratteri

const char* rank_txt[] = {"Ace", "Deuce", "Trey", "Four", "Five", "Six", "Seven", "Eight", "Nine", "Ten", "Jack", "Four", "King" } ;

Come questo

std::cout << rank_txt[m_rank - 1]
— MrPickles7
fonte
2
E se la mia enumerazione inizia dal 2000? Questa soluzione non funzionerà.
— Sitesh
3 
#include <iostream>
using std::cout;
using std::endl;

enum TEnum
{ 
  EOne,
  ETwo,
  EThree,
  ELast
};

#define VAR_NAME_HELPER(name) #name
#define VAR_NAME(x) VAR_NAME_HELPER(x)

#define CHECK_STATE_STR(x) case(x):return VAR_NAME(x);

const char *State2Str(const TEnum state)
{
  switch(state)
  {
    CHECK_STATE_STR(EOne);
    CHECK_STATE_STR(ETwo);
    CHECK_STATE_STR(EThree);
    CHECK_STATE_STR(ELast);
    default:
      return "Invalid";
  }
}

int main()
{
  int myInt=12345;
  cout << VAR_NAME(EOne) " " << VAR_NAME(myInt) << endl;

  for(int i = -1; i < 5;   i)
    cout << i << " " << State2Str((TEnum)i) << endl;
  return 0;
}
— Vladimir Chernyshev
fonte
2

Potresti usare un contenitore di mappe stl ....

typedef map<Errors, string> ErrorMap;

ErrorMap m;
m.insert(ErrorMap::value_type(ErrorA, "ErrorA"));
m.insert(ErrorMap::value_type(ErrorB, "ErrorB"));
m.insert(ErrorMap::value_type(ErrorC, "ErrorC"));

Errors error = ErrorA;

cout << m[error] << endl;
— Adrian Regan
fonte
4
In che modo questa mappa è migliore di quella switch(n) { case XXX: return "XXX"; ... }? Quale ha la ricerca O (1) e non ha bisogno di essere inizializzato? O le enumerazioni cambiano in qualche modo durante il runtime?
— Nordic Mainframe
Sono d'accordo con @Luther Blissett sull'uso dell'istruzione switch (o anche di un puntatore a funzione)
— KedarX
1
Bene, potrebbe voler produrre "Questo mio caro amico Luther è Errore A o" Questo mio caro amico Adrian è Errore B. "Inoltre, l'uso di map rimuove la dipendenza dalle firme iostream, in modo che sia libero di usarlo altrove nel codice con concatenazione di stringhe, ad esempio, stringa x = "Hello" + m [ErrorA], ecc.
— Adrian Regan
Sono sicuro che std :: map contenga molti if e switch. Lo leggerei come 'come posso farlo senza che io scriva if e switch'
— Nordic Mainframe
Sono sicuro di sì, ma di certo non richiede di scrivere una sceneggiatura in Lua per risolvere il problema ...
— Adrian Regan
1

Per questo problema, eseguo una funzione di aiuto come questa:

const char* name(Id id) {
    struct Entry {
        Id id;
        const char* name;
    };
    static const Entry entries[] = {
        { ErrorA, "ErrorA" },
        { ErrorB, "ErrorB" },
        { 0, 0 }
    }
    for (int it = 0; it < gui::SiCount; ++it) {
        if (entries[it].id == id) {
            return entries[it].name;
        }
    }
   return 0;
}

La ricerca lineare è generalmente più efficiente rispetto std::mapa piccole raccolte come questa.

— Johan Kotlinski
fonte
1

Questa soluzione non richiede l'utilizzo di strutture dati o la creazione di un file diverso.

Fondamentalmente, definisci tutti i tuoi valori enum in un #define, quindi li usi nell'operatore <<. Molto simile alla risposta di @ jxh.

collegamento ideone per l'iterazione finale: http://ideone.com/hQTKQp

Codice completo:

#include <iostream>

#define ERROR_VALUES ERROR_VALUE(NO_ERROR)\
ERROR_VALUE(FILE_NOT_FOUND)\
ERROR_VALUE(LABEL_UNINITIALISED)

enum class Error
{
#define ERROR_VALUE(NAME) NAME,
    ERROR_VALUES
#undef ERROR_VALUE
};

inline std::ostream& operator<<(std::ostream& os, Error err)
{
    int errVal = static_cast<int>(err);
    switch (err)
    {
#define ERROR_VALUE(NAME) case Error::NAME: return os << "[" << errVal << "]" #NAME;
    ERROR_VALUES
#undef ERROR_VALUE
    default:
        // If the error value isn't found (shouldn't happen)
        return os << errVal;
    }
}

int main() {
    std::cout << "Error: " << Error::NO_ERROR << std::endl;
    std::cout << "Error: " << Error::FILE_NOT_FOUND << std::endl;
    std::cout << "Error: " << Error::LABEL_UNINITIALISED << std::endl;
    return 0;
}

Produzione:

Error: [0]NO_ERROR
Error: [1]FILE_NOT_FOUND
Error: [2]LABEL_UNINITIALISED

Una cosa bella di farlo in questo modo è che puoi anche specificare i tuoi messaggi personalizzati per ogni errore se pensi di averne bisogno:

#include <iostream>

#define ERROR_VALUES ERROR_VALUE(NO_ERROR, "Everything is fine")\
ERROR_VALUE(FILE_NOT_FOUND, "File is not found")\
ERROR_VALUE(LABEL_UNINITIALISED, "A component tried to the label before it was initialised")

enum class Error
{
#define ERROR_VALUE(NAME,DESCR) NAME,
    ERROR_VALUES
#undef ERROR_VALUE
};

inline std::ostream& operator<<(std::ostream& os, Error err)
{
    int errVal = static_cast<int>(err);
    switch (err)
    {
#define ERROR_VALUE(NAME,DESCR) case Error::NAME: return os << "[" << errVal << "]" #NAME <<"; " << DESCR;
    ERROR_VALUES
#undef ERROR_VALUE
    default:
        return os << errVal;
    }
}

int main() {
    std::cout << "Error: " << Error::NO_ERROR << std::endl;
    std::cout << "Error: " << Error::FILE_NOT_FOUND << std::endl;
    std::cout << "Error: " << Error::LABEL_UNINITIALISED << std::endl;
    return 0;
}

Produzione:

Error: [0]NO_ERROR; Everything is fine
Error: [1]FILE_NOT_FOUND; File is not found
Error: [2]LABEL_UNINITIALISED; A component tried to the label before it was initialised

Se ti piace rendere i tuoi codici / descrizioni di errore molto descrittivi, potresti non volerli nelle build di produzione. Disattivarli in modo che venga stampato solo il valore è facile:

inline std::ostream& operator<<(std::ostream& os, Error err)
{
    int errVal = static_cast<int>(err);
    switch (err)
    {
    #ifndef PRODUCTION_BUILD // Don't print out names in production builds
    #define ERROR_VALUE(NAME,DESCR) case Error::NAME: return os << "[" << errVal << "]" #NAME <<"; " << DESCR;
        ERROR_VALUES
    #undef ERROR_VALUE
    #endif
    default:
        return os << errVal;
    }
}

Produzione:

Error: 0
Error: 1
Error: 2

Se questo è il caso, la ricerca del numero di errore 525 sarebbe un PITA. Possiamo specificare manualmente i numeri nell'enumerazione iniziale in questo modo:

#define ERROR_VALUES ERROR_VALUE(NO_ERROR, 0, "Everything is fine")\
ERROR_VALUE(FILE_NOT_FOUND, 1, "File is not found")\
ERROR_VALUE(LABEL_UNINITIALISED, 2, "A component tried to the label before it was initialised")\
ERROR_VALUE(UKNOWN_ERROR, -1, "Uh oh")

enum class Error
{
#define ERROR_VALUE(NAME,VALUE,DESCR) NAME=VALUE,
    ERROR_VALUES
#undef ERROR_VALUE
};

inline std::ostream& operator<<(std::ostream& os, Error err)
{
    int errVal = static_cast<int>(err);
    switch (err)
    {
#ifndef PRODUCTION_BUILD // Don't print out names in production builds
#define ERROR_VALUE(NAME,VALUE,DESCR) case Error::NAME: return os << "[" #VALUE  "]" #NAME <<"; " << DESCR;
    ERROR_VALUES
#undef ERROR_VALUE
#endif
    default:
        return os <<errVal;
    }
}
    ERROR_VALUES
#undef ERROR_VALUE
#endif
    default:
    {
        // If the error value isn't found (shouldn't happen)
        return os << static_cast<int>(err);
        break;
    }
    }
}

Produzione:

Error: [0]NO_ERROR; Everything is fine
Error: [1]FILE_NOT_FOUND; File is not found
Error: [2]LABEL_UNINITIALISED; A component tried to the label before it was initialised
Error: [-1]UKNOWN_ERROR; Uh oh
— Xiao
fonte
0

Cosa ne pensi di questo?

    enum class ErrorCodes : int{
          InvalidInput = 0
    };

    std::cout << ((int)error == 0 ? "InvalidInput" : "") << std::endl;

ecc ... So che questo è un esempio altamente artificioso ma penso che abbia un'applicazione dove applicabile e necessario ed è certamente più breve che scrivere uno script per esso.

— user633658
fonte
0

Usa il preprocessore:

#define VISIT_ERROR(FIRST, MIDDLE, LAST) \
    FIRST(ErrorA) MIDDLE(ErrorB) /* MIDDLE(ErrorB2) */ LAST(ErrorC)

enum Errors
{
    #define ENUMFIRST_ERROR(E)  E=0,
    #define ENUMMIDDLE_ERROR(E) E,
    #define ENUMLAST_ERROR(E)   E
    VISIT_ERROR(ENUMFIRST_ERROR, ENUMMIDDLE_ERROR, ENUMLAST_ERROR)
    // you might undefine the 3 macros defined above
};

std::string toString(Error e)
{
    switch(e)
    {
    #define CASERETURN_ERROR(E)  case E: return #E;
    VISIT_ERROR(CASERETURN_ERROR, CASERETURN_ERROR, CASERETURN_ERROR)
    // you might undefine the above macro.
    // note that this will produce compile-time error for synonyms in enum;
    // handle those, if you have any, in a distinct macro

    default:
        throw my_favourite_exception();
    }
}

Il vantaggio di questo approccio è che: - è ancora semplice da capire, tuttavia - consente varie visite (non solo stringa)

Se sei disposto a eliminare il primo, crea una macro FOREACH (), quindi #define ERROR_VALUES() (ErrorA, ErrorB, ErrorC)scrivi i tuoi visitatori in termini di FOREACH (). Quindi prova a superare una revisione del codice :).

— lorro
fonte
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.