change constants from #define to const var val

Update contributing.md accordingly
This commit is contained in:
2016-09-18 00:59:23 +03:00
parent 6449465be2
commit ee6cf60aa4
8 changed files with 100 additions and 97 deletions

View File

@ -54,6 +54,7 @@ for more details. To avoid manual labor there is automatic cmake target named
```
* C-like `NULL`, use `nullptr` instead.
* C-like constant definition, use `const vartype foo = bar` definition instead.
* It is highly recommended to avoid implicit casts. Exception `nullptr` casts to
boolean, e.g.:

View File

@ -23,12 +23,11 @@
#include "version.h"
#ifndef LOG_FORMAT
#define LOG_FORMAT \
"[%{time process}][%{if-debug}DD%{endif}%{if-info}II%{endif}%{if-" \
"warning}WW%{endif}%{if-critical}CC%{endif}%{if-fatal}FF%{endif}][%{" \
"category}][%{function}] %{message}"
#endif /* LOG_FORMAT */
const char LOG_FORMAT[] = "[%{time "
"process}][%{if-debug}DD%{endif}%{if-info}II%{endif}%"
"{if-warning}WW%{endif}%{if-critical}CC%{endif}%{if-"
"fatal}FF%{endif}][%{category}][%{function}] "
"%{message}";
Q_DECLARE_LOGGING_CATEGORY(LOG_AW)

View File

@ -83,7 +83,7 @@ void AWBugReporter::sendBugReport(const QString title, const QString body)
connect(manager, SIGNAL(finished(QNetworkReply *)), this,
SLOT(issueReplyRecieved(QNetworkReply *)));
QNetworkRequest request(QUrl(BUGTRACKER_API));
QNetworkRequest request = QNetworkRequest(QUrl(BUGTRACKER_API));
request.setHeader(QNetworkRequest::ContentTypeHeader, "application/json");
// generate payload

View File

@ -22,10 +22,6 @@
#include "abstractextitem.h"
#define YAHOO_QUOTES_URL "https://query.yahooapis.com/v1/public/yql"
#define YAHOO_QUOTES_QUERY \
"select * from yahoo.finance.quotes where symbol='%1'"
namespace Ui
{
@ -38,6 +34,10 @@ class ExtQuotes : public AbstractExtItem
Q_PROPERTY(QString ticker READ ticker WRITE setTicker)
public:
const char *YAHOO_QUOTES_URL = "https://query.yahooapis.com/v1/public/yql";
const char *YAHOO_QUOTES_QUERY
= "select * from yahoo.finance.quotes where symbol='%1'";
explicit ExtQuotes(QWidget *parent, const QString filePath = QString());
virtual ~ExtQuotes();
ExtQuotes *copy(const QString _fileName, const int _number);

View File

@ -20,17 +20,17 @@
#include "abstractweatherprovider.h"
// we are using own server to pass requests to OpenWeatherMap because it
// requires specific APPID which belongs to developer not user
#define OWM_WEATHER_URL "http://arcanis.me/weather"
#define OWM_FORECAST_URL "http://arcanis.me/forecast"
class OWMWeatherProvider : public AbstractWeatherProvider
{
Q_OBJECT
public:
// we are using own server to pass requests to OpenWeatherMap because it
// requires specific APPID which belongs to developer not user
const char *OWM_WEATHER_URL = "http://arcanis.me/weather";
const char *OWM_FORECAST_URL = "http://arcanis.me/forecast";
explicit OWMWeatherProvider(QObject *parent, const int number);
virtual ~OWMWeatherProvider();
void initUrl(const QString city, const QString country, const int);

View File

@ -20,17 +20,17 @@
#include "abstractweatherprovider.h"
#define YAHOO_WEATHER_URL "https://query.yahooapis.com/v1/public/yql"
#define YAHOO_WEATHER_QUERY \
"select * from weather.forecast where u='c' and woeid in (select woeid " \
"from geo.places(1) where text='%1, %2')"
class YahooWeatherProvider : public AbstractWeatherProvider
{
Q_OBJECT
public:
const char *YAHOO_WEATHER_URL = "https://query.yahooapis.com/v1/public/yql";
const char *YAHOO_WEATHER_QUERY = "select * from weather.forecast where "
"u='c' and woeid in (select woeid from "
"geo.places(1) where text='%1, %2')";
explicit YahooWeatherProvider(QObject *parent, const int number);
virtual ~YahooWeatherProvider();
void initUrl(const QString city, const QString country, const int);

View File

@ -24,8 +24,6 @@
#include "abstractextsysmonsource.h"
#define MPD_STATUS_REQUEST "currentsong\nstatus\n"
class QProcess;
@ -34,6 +32,8 @@ class PlayerSource : public AbstractExtSysMonSource
Q_OBJECT
public:
const char *MPD_STATUS_REQUEST = "currentsong\nstatus\n";
explicit PlayerSource(QObject *parent, const QStringList args);
virtual ~PlayerSource();
QVariant data(QString source);

View File

@ -3,103 +3,106 @@
// information
#define NAME "Awesome Widgets"
#define VERSION "@PROJECT_VERSION@"
#define COMMIT_SHA "@PROJECT_COMMIT_SHA@"
#define AUTHOR "@PROJECT_AUTHOR@"
#define TRANSLATORS \
"Ernesto Aviles Vzqz (Spanish), Mermouy (French), underr (Brazillian " \
"Portuguese), Viktor Slobodyan (Ukrainian), Lemueler (Chinese), Heimen " \
"Stoffels (Dutch), Mariusz Kocoń (Polish)"
#define EMAIL "@PROJECT_CONTACT@"
#define LICENSE "@PROJECT_LICENSE@"
#define TRDPARTY_LICENSE \
"QReplyTimeout " \
"wrapper,no,http://codereview.stackexchange.com/questions/30031/" \
"qnetworkreply-network-reply-timeout-helper"
#define SPECIAL_THANKS \
"Yahoo! Finance,https://finance.yahoo.com/;Yahoo! " \
"Weather,https://weather.yahoo.com/;JetBrains,https://www.jetbrains.com/" \
";OpenWeatherMap,http://openweathermap.org/"
#define CHANGELOG "@PROJECT_CHANGELOG@"
const char NAME[] = "Awesome Widgets";
const char VERSION[] = "@PROJECT_VERSION@";
const char COMMIT_SHA[] = "@PROJECT_COMMIT_SHA@";
const char AUTHOR[] = "@PROJECT_AUTHOR@";
const char TRANSLATORS[] = "Ernesto Aviles Vzqz (Spanish), Mermouy (French), "
"underr (Brazillian Portuguese), Viktor Slobodyan "
"(Ukrainian), Lemueler (Chinese), Heimen Stoffels "
"(Dutch), Mariusz Kocoń (Polish)";
const char EMAIL[] = "@PROJECT_CONTACT@";
const char LICENSE[] = "@PROJECT_LICENSE@";
const char TRDPARTY_LICENSE[] = "QReplyTimeout "
"wrapper,no,http://"
"codereview.stackexchange.com/questions/30031/"
"qnetworkreply-network-reply-timeout-helper";
const char SPECIAL_THANKS[]
= "Yahoo! Finance,https://finance.yahoo.com/;Yahoo! "
"Weather,https://weather.yahoo.com/;JetBrains,https://www.jetbrains.com/"
";OpenWeatherMap,http://openweathermap.org/";
const char CHANGELOG[] = "@PROJECT_CHANGELOG@";
// configuraion
// graphical items api version
#define AWGIAPI 5
const int AWGIAPI = 5;
// extquotes api version
#define AWEQAPI 3
const int AWEQAPI = 3;
// extscript api version
#define AWESAPI 4
const int AWESAPI = 4;
// extupgrade api version
#define AWEUAPI 3
const int AWEUAPI = 3;
// extweather api version
#define AWEWAPI 3
const int AWEWAPI = 3;
// formatter api version
#define AWEFAPI 2
const int AWEFAPI = 2;
// telemetry api version
#define AWTEAPI 1
const int AWTEAPI = 1;
// network requests timeout, ms
#define REQUEST_TIMEOUT 3000
const int REQUEST_TIMEOUT = 3000;
// available time keys
#define TIME_KEYS \
"d,dd,ddd,dddd,M,MM,MMM,MMMM,yy,yyyy,h,hh,H,HH,m,mm,s,ss,t,a,ap,A,AP"
const char TIME_KEYS[]
= "d,dd,ddd,dddd,M,MM,MMM,MMMM,yy,yyyy,h,hh,H,HH,m,mm,s,ss,t,a,ap,A,AP";
// static keys
#define STATIC_KEYS \
"time,isotime,shorttime,longtime,tstime,ctime,uptime,cuptime,cpucl,cpu," \
"gputemp,gpu,memmb,memgb,memfreemb,memfreegb,memtotmb,memtotgb,memusedmb," \
"memusedgb,mem,swapmb,swapgb,swapfreemb,swapfreegb,swaptotmb,swaptotgb," \
"swap,downunits,upunits,downkb,downtotalkb,downtotal,down,uptotalkb," \
"uptotal,upkb,up,netdev,ac,bat,album,artist,duration,progress,title," \
"dalbum,dartist,dtitle,salbum,sartist,stitle,pscount,pstotal,ps,desktop," \
"ndesktop,tdesktops,la15,la5,la1"
const char STATIC_KEYS[]
= "time,isotime,shorttime,longtime,tstime,ctime,uptime,cuptime,cpucl,cpu,"
"gputemp,gpu,memmb,memgb,memfreemb,memfreegb,memtotmb,memtotgb,memusedmb,"
"memusedgb,mem,swapmb,swapgb,swapfreemb,swapfreegb,swaptotmb,swaptotgb,"
"swap,downunits,upunits,downkb,downtotalkb,downtotal,down,uptotalkb,"
"uptotal,upkb,up,netdev,ac,bat,album,artist,duration,progress,title,"
"dalbum,dartist,dtitle,salbum,sartist,stitle,pscount,pstotal,ps,desktop,"
"ndesktop,tdesktops,la15,la5,la1";
#cmakedefine BUILD_FUTURE
#cmakedefine BUILD_LOAD
#cmakedefine BUILD_TESTING
// links
#define HOMEPAGE "https://arcanis.me/projects/awesome-widgets/"
#define REPOSITORY "https://github.com/arcan1s/awesome-widgets"
#define RELEASES "https://github.com/arcan1s/awesome-widgets/releases/tag/V."
#define VERSION_API \
"https://api.github.com/repos/arcan1s/awesome-widgets/releases"
#define BUGTRACKER "https://github.com/arcan1s/awesome-widgets/issues"
#define BUGTRACKER_API "http://arcanis.me/repos/arcan1s/awesome-widgets/issues"
#define TRANSLATION "https://github.com/arcan1s/awesome-widgets/issues/14"
#define AUR_PACKAGES \
"https://aur.archlinux.org/packages/plasma5-applet-awesome-widgets/"
#define OPENSUSE_PACKAGES "http://software.opensuse.org/package/awesome-widgets"
const char HOMEPAGE[] = "https://arcanis.me/projects/awesome-widgets/";
const char REPOSITORY[] = "https://github.com/arcan1s/awesome-widgets";
const char RELEASES[]
= "https://github.com/arcan1s/awesome-widgets/releases/tag/V.";
const char VERSION_API[]
= "https://api.github.com/repos/arcan1s/awesome-widgets/releases";
const char BUGTRACKER[] = "https://github.com/arcan1s/awesome-widgets/issues";
const char BUGTRACKER_API[]
= "http://arcanis.me/repos/arcan1s/awesome-widgets/issues";
const char TRANSLATION[]
= "https://github.com/arcan1s/awesome-widgets/issues/14";
const char AUR_PACKAGES[]
= "https://aur.archlinux.org/packages/plasma5-applet-awesome-widgets/";
const char OPENSUSE_PACKAGES[]
= "http://software.opensuse.org/package/awesome-widgets";
// build information
#define BUILD_DATE "@CURRENT_DATE@"
#define DATE "2013-@CURRENT_YEAR@"
const char BUILD_DATE[] = "@CURRENT_DATE@";
const char DATE[] = "2013-@CURRENT_YEAR@";
// cmake properties
#define CMAKE_BUILD_TYPE "@CMAKE_BUILD_TYPE@"
#define CMAKE_CXX_COMPILER "@CMAKE_CXX_COMPILER@"
#define CMAKE_CXX_FLAGS "@CMAKE_CXX_FLAGS@"
#define CMAKE_CXX_FLAGS_DEBUG "@CMAKE_CXX_FLAGS_DEBUG@"
#define CMAKE_CXX_FLAGS_RELEASE "@CMAKE_CXX_FLAGS_RELEASE@"
#define CMAKE_CXX_FLAGS_OPTIMIZATION "@CMAKE_CXX_FLAGS_OPTIMIZATION@"
#define CMAKE_DEFINITIONS "@CMAKE_DEFINITIONS@"
#define CMAKE_INSTALL_PREFIX "@CMAKE_INSTALL_PREFIX@"
#define CMAKE_MODULE_LINKER_FLAGS "@CMAKE_MODULE_LINKER_FLAGS@"
#define CMAKE_SHARED_LINKER_FLAGS "@CMAKE_SHARED_LINKER_FLAGS@"
const char CMAKE_BUILD_TYPE[] = "@CMAKE_BUILD_TYPE@";
const char CMAKE_CXX_COMPILER[] = "@CMAKE_CXX_COMPILER@";
const char CMAKE_CXX_FLAGS[] = "@CMAKE_CXX_FLAGS@";
const char CMAKE_CXX_FLAGS_DEBUG[] = "@CMAKE_CXX_FLAGS_DEBUG@";
const char CMAKE_CXX_FLAGS_RELEASE[] = "@CMAKE_CXX_FLAGS_RELEASE@";
const char CMAKE_CXX_FLAGS_OPTIMIZATION[] = "@CMAKE_CXX_FLAGS_OPTIMIZATION@";
const char CMAKE_DEFINITIONS[] = "@CMAKE_DEFINITIONS@";
const char CMAKE_INSTALL_PREFIX[] = "@CMAKE_INSTALL_PREFIX@";
const char CMAKE_MODULE_LINKER_FLAGS[] = "@CMAKE_MODULE_LINKER_FLAGS@";
const char CMAKE_SHARED_LINKER_FLAGS[] = "@CMAKE_SHARED_LINKER_FLAGS@";
// components
#define BUILD_COVERAGE "@BUILD_COVERAGE@"
#define BUILD_PLASMOIDS "@BUILD_PLASMOIDS@"
#define BUILD_DEB_PACKAGE "@BUILD_DEB_PACKAGE@"
#define BUILD_RPM_PACKAGE "@BUILD_RPM_PACKAGE@"
#define CLANGFORMAT_EXECUTABLE "@CLANGFORMAT_EXECUTABLE@"
#define COVERITY_COMMENT "@COVERITY_COMMENT@"
#define COVERITY_DIRECTORY "@COVERITY_DIRECTORY@"
#define COVERITY_EMAIL "@COVERITY_EMAIL@"
#define COVERITY_EXECUTABLE "@COVERITY_EXECUTABLE@"
#define COVERITY_URL "@COVERITY_URL@"
#define CPPCHECK_EXECUTABLE "@CPPCHECK_EXECUTABLE@"
const char BUILD_PLASMOIDS[] = "@BUILD_PLASMOIDS@";
const char BUILD_DEB_PACKAGE[] = "@BUILD_DEB_PACKAGE@";
const char BUILD_RPM_PACKAGE[] = "@BUILD_RPM_PACKAGE@";
const char CLANGFORMAT_EXECUTABLE[] = "@CLANGFORMAT_EXECUTABLE@";
const char COVERITY_COMMENT[] = "@COVERITY_COMMENT@";
const char COVERITY_DIRECTORY[] = "@COVERITY_DIRECTORY@";
const char COVERITY_EMAIL[] = "@COVERITY_EMAIL@";
const char COVERITY_EXECUTABLE[] = "@COVERITY_EXECUTABLE@";
const char COVERITY_URL[] = "@COVERITY_URL@";
const char CPPCHECK_EXECUTABLE[] = "@CPPCHECK_EXECUTABLE@";
// additional functions
#define PROP_FUTURE "@BUILD_FUTURE@"
#define PROP_LOAD "@BUILD_LOAD@"
#define PROP_TEST "@BUILD_TESTING@"
const char PROP_FUTURE[] = "@BUILD_FUTURE@";
const char PROP_LOAD[] = "@BUILD_LOAD@";
const char PROP_TEST[] = "@BUILD_TESTING@";
#endif /* VERSION_H */