1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
|
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
//
// Copyright : (C) 2015 Eran Ifrah
// File name : PHPEntityVariable.h
//
// -------------------------------------------------------------------------
// A
// _____ _ _ _ _
// / __ \ | | | | (_) |
// | / \/ ___ __| | ___| | _| |_ ___
// | | / _ \ / _ |/ _ \ | | | __/ _ )
// | \__/\ (_) | (_| | __/ |___| | || __/
// \____/\___/ \__,_|\___\_____/_|\__\___|
//
// F i l e
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
#ifndef PHPENTITYVARIABLE_H
#define PHPENTITYVARIABLE_H
#include "codelite_exports.h"
#include "PHPEntityBase.h" // Base class: PHPEntityBase
#include <wx/string.h>
class WXDLLIMPEXP_CL PHPEntityVariable : public PHPEntityBase
{
public:
virtual wxString FormatPhpDoc(const CommentConfigData& data) const;
virtual wxString GetDisplayName() const;
virtual bool Is(eEntityType type) const;
virtual wxString Type() const;
virtual void FromResultSet(wxSQLite3ResultSet& res);
protected:
wxString m_typeHint;
// Incase this variable is instantiated with an expression
// keep it
wxString m_expressionHint;
wxString m_defaultValue;
public:
/**
* @brief
* @return
*/
wxString GetScope() const;
virtual void Store(PHPLookupTable* lookup);
virtual void PrintStdout(int indent) const;
void FromJSON(const JSONItem& json);
JSONItem ToJSON() const;
/**
* @brief format this variable
*/
wxString ToFuncArgString() const;
PHPEntityVariable();
virtual ~PHPEntityVariable();
void SetExpressionHint(const wxString& expressionHint) { this->m_expressionHint = expressionHint; }
const wxString& GetExpressionHint() const { return m_expressionHint; }
void SetVisibility(int visibility);
void SetTypeHint(const wxString& typeHint) { this->m_typeHint = typeHint; }
const wxString& GetTypeHint() const { return m_typeHint; }
void SetDefaultValue(const wxString& defaultValue) { this->m_defaultValue = defaultValue; }
const wxString& GetDefaultValue() const { return m_defaultValue; }
wxString GetNameNoDollar() const;
virtual wxString ToTooltip() const;
// Aliases
void SetIsReference(bool isReference) { SetFlag(kVar_Reference, isReference); }
void SetIsNullable(bool isNullable) { SetFlag(kVar_Nullable, isNullable); }
bool IsMember() const { return HasFlag(kVar_Member); }
bool IsPublic() const { return HasFlag(kVar_Public); }
bool IsPrivate() const { return HasFlag(kVar_Private); }
bool IsProtected() const { return HasFlag(kVar_Protected); }
bool IsFunctionArg() const { return HasFlag(kVar_FunctionArg); }
bool IsConst() const { return HasFlag(kVar_Const); }
bool IsReference() const { return HasFlag(kVar_Reference); }
bool IsNullable() const { return HasFlag(kVar_Nullable); }
bool IsStatic() const { return HasFlag(kVar_Static); }
bool IsDefine() const { return HasFlag(kVar_Define); }
bool IsBoolean() const { return GetTypeHint() == "boolean" || GetTypeHint() == "bool"; }
};
#endif // PHPENTITYVARIABLE_H
|