Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate deprecation attribute for deprecated functions/constants #31

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+28 −2
Open

Generate deprecation attribute for deprecated functions/constants #31

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33c0ece
Generate deprecation attribute for deprecated functions/constants
kubo39 Jan 6, 2020
35a1023
Update source/gtd/GirConstant.d
kubo39 May 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion source/gtd/GirConstant.d
View file
Original file line number Diff line number Diff line change
@@ -33,6 +33,8 @@ final class GirConstant
string cType;
string value;
string doc;
bool isDeprecated;
string docDeprecated;

GirType type;
GirPackage pack;
@@ -52,6 +54,8 @@ final class GirConstant
cType = reader.front.attributes["c:type"];
else
cType = reader.front.attributes["c:identifier"];
if ( "deprecated" in reader.front.attributes )
isDeprecated = reader.front.attributes["deprecated"] == "1";

reader.popFront();

@@ -71,7 +75,8 @@ final class GirConstant
break;
case "doc-deprecated":
reader.popFront();
doc ~= "\n\nDeprecated: "~ reader.front.value;
docDeprecated = reader.front.value;
doc ~= "\n\nDeprecated: " ~ docDeprecated;
reader.popFront();
break;
case "source-position":
@@ -102,6 +107,14 @@ final class GirConstant
buff ~= " */";
}

if ( isDeprecated )
{
if ( docDeprecated )
buff ~= `deprecated("` ~ docDeprecated ~ `")`;
else
buff ~= `deprecated("` ~ name ~ ` has been deprecated.")`;
}

if ( type.name in pack.collectedAliases && pack.collectedAliases[type.name].baseType.cType.among("gint64", "guint64") )
value ~= "UL";

15 changes: 14 additions & 1 deletion source/gtd/GirFunction.d
View file
Original file line number Diff line number Diff line change
@@ -55,6 +55,8 @@ final class GirFunction
string cType;
string libVersion;
string movedTo;
bool isDeprecated;
string docDeprecated;
bool virtual = false;
bool throws = false;
bool lookupOverride; /// Force marking this function with override.
@@ -107,6 +109,8 @@ final class GirFunction
throws = reader.front.attributes["throws"] == "1";
if ( "moved-to" in reader.front.attributes )
movedTo = reader.front.attributes["moved-to"];
if ( "deprecated" in reader.front.attributes )
isDeprecated = reader.front.attributes["deprecated"] == "1";

reader.popFront();

@@ -127,7 +131,8 @@ final class GirFunction
break;
case "doc-deprecated":
reader.popFront();
doc ~= "\n\nDeprecated: "~ reader.front.value;
docDeprecated = reader.front.value;
doc ~= "\n\nDeprecated: " ~ docDeprecated;
reader.popFront();
break;
case "doc-version":
@@ -361,6 +366,14 @@ final class GirFunction
resolveLength();
writeDocs(buff);

if ( isDeprecated )
{
if ( docDeprecated.length )
buff ~= `deprecated("` ~ docDeprecated ~ `")`;
else
buff ~= `deprecated("` ~ name ~ ` has been deprecated.")`;
}

if ( type == GirFunctionType.Constructor )
{
dec ~= "this(";