124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner//===-- Language.h ----------------------------------------------*- C++ -*-===// 224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner// 324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner// The LLVM Compiler Infrastructure 424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner// 524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner// This file is distributed under the University of Illinois Open Source 624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner// License. See LICENSE.TXT for details. 724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner// 824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner//===----------------------------------------------------------------------===// 924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 1024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner#ifndef liblldb_Language_h_ 1124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner#define liblldb_Language_h_ 1224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 1324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner#include "lldb/lldb-private.h" 1424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 1524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattnernamespace lldb_private { 1624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 1724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner//---------------------------------------------------------------------- 1824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner/// @class Language Language.h "lldb/Core/Language.h" 1924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner/// @brief Encapsulates the programming language for an lldb object. 2024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner/// 2124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner/// Languages are represented by an enumeration value. 2224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner/// 2324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner/// The enumeration values used when describing the programming language 2424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner/// are the same values as the latest DWARF specification. 2524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner//---------------------------------------------------------------------- 2624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattnerclass Language 2724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner{ 2824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattnerpublic: 2924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 3024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// Construct with optional language enumeration. 3124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 329488b7423b556c7c777b721d2094fd5ec4a47578Greg Clayton Language(lldb::LanguageType language = lldb::eLanguageTypeUnknown); 3324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 3424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 3524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// Destructor. 3624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// 3724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// The destructor is virtual in case this class is subclassed. 3824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 3924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner virtual 4024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner ~Language(); 4124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 4224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 4324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// Get the language value as a NULL termianted C string. 4424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// 4524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// @return 4624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// The C string representation of the language. The returned 4724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// string does not need to be freed as it comes from constant 4824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// strings. NULL can be returned when the language is set to 499488b7423b556c7c777b721d2094fd5ec4a47578Greg Clayton /// a value that doesn't match of of the lldb::LanguageType 5024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// enumerations. 5124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 5224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner const char * 5324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner AsCString (lldb::DescriptionLevel level = lldb::eDescriptionLevelBrief) const; 5424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 5524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner void 5624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner Clear(); 5724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 5824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner void 5924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner GetDescription (Stream *s, lldb::DescriptionLevel level) const; 6024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 6124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 6224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// Dump the language value to the stream \a s. 6324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// 6424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// @param[in] s 6524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// The stream to which to dump the language description. 6624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 6724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner void 6824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner Dump(Stream *s) const; 6924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 7024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 7124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// Get accessor for the language. 7224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// 7324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// @return 7424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// The enumeration value that describes the programming 7524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// language that an object is associated with. 7624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 7749ce8969d3154e1560106cfe530444c09410f217Greg Clayton virtual lldb::LanguageType 7824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner GetLanguage() const; 7924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 8024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 8124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// Set accessor for the language. 8224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// 8324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// @param[in] language 8424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// The new enumeration value that describes the programming 8524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// language that an object is associated with. 8624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 8724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner void 889488b7423b556c7c777b721d2094fd5ec4a47578Greg Clayton SetLanguage(lldb::LanguageType language); 8924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 9024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 9124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// Set accessor for the language. 9224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// 9324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// @param[in] language_cstr 9424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner /// The language name as a C string. 9524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 9624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner bool 9724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner SetLanguageFromCString(const char *language_cstr); 9824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 9924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 10024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattnerprotected: 10124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 10224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner // Member variables 10324943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner //------------------------------------------------------------------ 1049488b7423b556c7c777b721d2094fd5ec4a47578Greg Clayton lldb::LanguageType m_language; ///< The programming language enumeration value. 1059488b7423b556c7c777b721d2094fd5ec4a47578Greg Clayton ///< The enumeration values are the same as the 1069488b7423b556c7c777b721d2094fd5ec4a47578Greg Clayton ///< latest DWARF specification. 10724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner}; 10824943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 10924943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner//-------------------------------------------------------------- 11024943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner/// Stream the language enumeration as a string object to a 11124943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner/// Stream. 11224943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner//-------------------------------------------------------------- 11324943d2ee8bfaa7cf5893e4709143924157a5c1eChris LattnerStream& operator << (Stream& s, const Language& language); 11424943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 11524943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner} // namespace lldb_private 11624943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner 11724943d2ee8bfaa7cf5893e4709143924157a5c1eChris Lattner#endif // liblldb_Language_h_ 118