mirror of
https://github.com/Bubberstation/Bubberstation.git
synced 2026-07-13 09:05:11 +01:00
Lints Against Unmanaged Local Defines (#74333)
# MAINTAINER - USE THE BUTTON THAT SAYS "MERGE MASTER" THEN SET THE PR TO AUTO-MERGE! IT'S MUCH EASIER FOR ME TO FIX THINGS BEFORE THEY SKEW RATHER THAN AFTER THE FACT. ## About The Pull Request Hey there, This took a while to do, but here's the gist: Python file now regexes every file in `/code` except for those that have some valid reason to be tacking on more global defines. Some of those reasons are simply just that I don't have the time right now (doing what you see in this PR took a few hours) to refactor and parse what should belong and what should be thrown out. For the time being though, this PR will at least _halt_ people making the mistake of not `#undef`ing any files they `#define` "locally", or within the scope of a file. Most people forget to do this and this leads to a lot of mess later on due to how many variables can be unmanaged on the global level. I've made this mistake, you've made this mistake, it's a common thing. Let's automatically check for it so it can be fixed no-stress. Scenarios this PR corrects: * Forgetting to undef a define but undeffing others. * Not undeffing any defines in your file. * Earmarking a define as a "file local" define, but not defining it. * Having a define be a "file local" define, but having it be used elsewhere. * Having a "local" define not even be in the file that it only shows up in. * Having a completely unused define* (* I kept some of these because they seemed important... Others were junked.) ## Why It's Good For The Game If you wanna use it across multiple files, no reason to not make it a global define (maybe there's a few reasons but let's assume that this is the 95% case). Let me know if you don't like how I re-arranged some of the defines and how you'd rather see it be implemented, and I'd be happy to do that. This was mostly just "eh does it need it or not" sorta stuff. I used a pretty cool way to detect if we should use the standardized GitHub "error" output, you can see the results of that here https://github.com/san7890/bruhstation/actions/runs/4549766579/jobs/8022186846#step:7:792 ## Changelog Nothing that really concerns players. (I fixed up all this stuff using vscode, no regexes beyond what you see in the python script. sorry downstreams)
This commit is contained in:
@@ -1057,4 +1057,6 @@
|
||||
if(kick_banned_players && (!is_admin || (is_admin && applies_to_admins)))
|
||||
qdel(other_player_client)
|
||||
|
||||
#undef MAX_ADMINBANS_PER_ADMIN
|
||||
#undef MAX_ADMINBANS_PER_HEADMIN
|
||||
#undef MAX_REASON_LENGTH
|
||||
|
||||
@@ -175,9 +175,6 @@
|
||||
#define SDQL2_STATE_SWITCHING 5
|
||||
#define SDQL2_STATE_HALTING 6
|
||||
|
||||
#define SDQL2_VALID_OPTION_TYPES list("proccall", "select", "priority", "autogc" , "sequential")
|
||||
#define SDQL2_VALID_OPTION_VALUES list("async", "blocking", "force_nulls", "skip_nulls", "high", "normal", "keep_alive" , "true")
|
||||
|
||||
#define SDQL2_OPTION_SELECT_OUTPUT_SKIP_NULLS (1<<0)
|
||||
#define SDQL2_OPTION_BLOCKING_CALLS (1<<1)
|
||||
#define SDQL2_OPTION_HIGH_PRIORITY (1<<2) //High priority SDQL query, allow using almost all of the tick.
|
||||
@@ -1231,3 +1228,21 @@ GLOBAL_DATUM_INIT(sdql2_vv_statobj, /obj/effect/statclick/sdql2_vv_all, new(null
|
||||
usr.log_message("non-holder clicked on a statclick! ([src])", LOG_ADMIN)
|
||||
return
|
||||
usr.client.debug_variables(GLOB.sdql2_queries)
|
||||
|
||||
#undef SDQL2_HALT_CHECK
|
||||
#undef SDQL2_IS_RUNNING
|
||||
#undef SDQL2_OPTION_BLOCKING_CALLS
|
||||
#undef SDQL2_OPTION_DO_NOT_AUTOGC
|
||||
#undef SDQL2_OPTION_HIGH_PRIORITY
|
||||
#undef SDQL2_OPTION_SELECT_OUTPUT_SKIP_NULLS
|
||||
#undef SDQL2_OPTION_SEQUENTIAL
|
||||
#undef SDQL2_OPTIONS_DEFAULT
|
||||
#undef SDQL2_STAGE_SWITCH_CHECK
|
||||
#undef SDQL2_STATE_ERROR
|
||||
#undef SDQL2_STATE_EXECUTING
|
||||
#undef SDQL2_STATE_HALTING
|
||||
#undef SDQL2_STATE_IDLE
|
||||
#undef SDQL2_STATE_PRESEARCH
|
||||
#undef SDQL2_STATE_SEARCHING
|
||||
#undef SDQL2_STATE_SWITCHING
|
||||
#undef SDQL2_TICK_CHECK
|
||||
|
||||
@@ -46,6 +46,25 @@
|
||||
//
|
||||
//////////
|
||||
|
||||
#define SDQL2_VALID_OPTION_TYPES list(\
|
||||
"autogc",\
|
||||
"priority",\
|
||||
"proccall",\
|
||||
"select",\
|
||||
"sequential",\
|
||||
)
|
||||
|
||||
#define SDQL2_VALID_OPTION_VALUES list(\
|
||||
"async",\
|
||||
"blocking",\
|
||||
"force_nulls",\
|
||||
"high",\
|
||||
"keep_alive" ,\
|
||||
"normal",\
|
||||
"skip_nulls",\
|
||||
"true",\
|
||||
)
|
||||
|
||||
/datum/sdql_parser
|
||||
var/query_type
|
||||
var/error = 0
|
||||
@@ -629,3 +648,6 @@
|
||||
i = variable(i, node)
|
||||
|
||||
return i
|
||||
|
||||
#undef SDQL2_VALID_OPTION_TYPES
|
||||
#undef SDQL2_VALID_OPTION_VALUES
|
||||
|
||||
@@ -793,3 +793,4 @@
|
||||
|
||||
#undef EXTERNAL_PM_USER
|
||||
#undef EXTERNALREPLYCOUNT
|
||||
#undef TGS_AHELP_USAGE
|
||||
|
||||
Reference in New Issue
Block a user