Skip to content

Commit

Permalink
[sipify] debug + fix multiline in SIP_RUN
Browse files Browse the repository at this point in the history
  • Loading branch information
@3nids
3nids committed Apr 27, 2017
1 parent eeba0ef commit ce77029
Show file tree
Hide file tree
Showing 3 changed files with 85 additions and 31 deletions.
86 changes: 56 additions & 30 deletions scripts/sipify.pl
View file
Expand Up @@ -2,14 +2,16 @@
use strict;
use warnings;
use File::Basename;
use Getopt::Long;

use constant PRIVATE => 0;
use constant PROTECTED => 1;
use constant PUBLIC => 2;

# TODO add contexts for
# "multiline function signatures"
# docustrings for QgsFeature::QgsAttributes
# read arguments
my $debug = 0;
GetOptions ("debug" => \$debug) or die("Error in command line arguments\n");
my $headerfile = $ARGV[0];

sub processDoxygenLine
{
Expand Down Expand Up @@ -38,8 +40,7 @@ sub processDoxygenLine
return "$line\n";
}

my $headerfile = $ARGV[0];

# read file
open(my $handle, "<", $headerfile) || die "Couldn't open '".$headerfile."' for reading because: ".$!;
chomp(my @lines = <$handle>);
close $handle;
Expand Down Expand Up @@ -71,26 +72,40 @@ sub processDoxygenLine
push @output, " * Do not edit manually ! Edit header and run scripts/sipify.pl again *\n";
push @output, " ************************************************************************/\n";

# write some code in front of line to know where the output comes from
$debug == 0 or push @output, "CODE SIP_RUN MultiLine\n";
sub dbg
{
my $msg = '';
$debug == 0 or $msg = sprintf("%-4s %-1d %-1d ", $_[0], $SIP_RUN, $MULTILINE_DEFINITION);
return $msg;
}
sub dbg_info
{
$debug == 0 or push @output, $_[0]."\n";
}

# main loop
while ($line_idx < $line_count){
$line = $lines[$line_idx];
$line_idx++;
#print "$line\n";

if ($line =~ m/^\s*SIP_FEATURE\( (\w+) \)(.*)$/){
push @output, "%Feature $1$2\n";
push @output, dbg("SF1")."%Feature $1$2\n";
next;
}
if ($line =~ m/^\s*SIP_IF_FEATURE\( (\!?\w+) \)(.*)$/){
push @output, "%If ($1)$2\n";
push @output, dbg("SF2")."%If ($1)$2\n";
next;
}
if ($line =~ m/^\s*SIP_CONVERT_TO_SUBCLASS_CODE(.*)$/){
push @output, "%ConvertToSubClassCode$1\n";
push @output, dbg("SCS")."%ConvertToSubClassCode$1\n";
next;
}

if ($line =~ m/^\s*SIP_END(.*)$/){
push @output, "%End$1\n";
push @output, dbg("SEN")."%End$1\n";
next;
}

Expand All @@ -99,6 +114,7 @@ sub processDoxygenLine

# skip #if 0 blocks
if ( $line =~ m/^\s*#if 0/){
dbg_info("skipping #if 0 block");
my $nesting_index = 0;
while ($line_idx < $line_count){
$line = $lines[$line_idx];
Expand All @@ -120,7 +136,7 @@ sub processDoxygenLine
if ( $line =~ m/^\s*#ifdef SIP_RUN/){
$SIP_RUN = 1;
if ($ACCESS == PRIVATE){
push @output, $private_section_line."\n";
push @output, dbg("PRV1").$private_section_line."\n";
}
next;
}
Expand Down Expand Up @@ -171,7 +187,7 @@ sub processDoxygenLine
elsif ( $line =~ m/^\s*#else/ && $global_nesting_index == 0 ){
# code here will be printed out
if ($ACCESS == PRIVATE){
push @output, $private_section_line."\n";
push @output, dbg("PRV2").$private_section_line."\n";
}
$SIP_RUN = 1;
last;
Expand All @@ -197,7 +213,7 @@ sub processDoxygenLine
# TYPE HEADER CODE
if ( $HEADER_CODE && $SIP_RUN == 0 ){
$HEADER_CODE = 0;
push @output, "%End\n";
push @output, dbg("HCE")."%End\n";
}

# Skip forward declarations
Expand All @@ -219,11 +235,13 @@ sub processDoxygenLine
$opening_line = pop(@output);
$#output >= 0 or die 'could not reach opening definition';
}
dbg_info("removed multiline definition of SIP_SKIP method");
$MULTILINE_DEFINITION = 0;
}
# also skip method body if there is one
if ($lines[$line_idx] =~ m/^\s*\{/){
my $nesting_index = 0;
dbg_info("skipping method body of SIP_SKIP method");
while ($line_idx < $line_count){
$line = $lines[$line_idx];
$line_idx++;
Expand Down Expand Up @@ -271,7 +289,7 @@ sub processDoxygenLine
$comment = '';
}
elsif ( $ACCESS == PRIVATE && $line =~ m/SIP_FORCE/){
push @output, $private_section_line."\n";
push @output, dbg("PRV3").$private_section_line."\n";
}
elsif ( $ACCESS == PRIVATE && $SIP_RUN == 0 ) {
$comment = '';
Expand All @@ -298,7 +316,7 @@ sub processDoxygenLine
}
}
$comment =~ s/\n+$//;
#push @output, $comment;
#push @output, dbg("XXX").$comment;
next;
}

Expand Down Expand Up @@ -341,7 +359,7 @@ sub processDoxygenLine
}
$line .= "\n%TypeHeaderCode\n#include \"" . basename($headerfile) . "\"";

push @output, "$line\n";
push @output, dbg("CLS")."$line\n";

# Skip opening curly bracket, we already added that above
my $skip = $lines[$line_idx];
Expand All @@ -356,7 +374,7 @@ sub processDoxygenLine

# Enum declaration
if ( $line =~ m/^\s*enum\s+\w+.*?$/ ){
push @output, "$line\n";
push @output, dbg("ENU1")."$line\n";
if ($line =~ m/\{((\s*\w+)(\s*=\s*[\w\s\d<|]+.*?)?(,?))+\s*\}/){
# one line declaration
$line !~ m/=/ or die 'spify.pl does not handle enum one liners with value assignment. Use multiple lines instead.';
Expand All @@ -367,17 +385,17 @@ sub processDoxygenLine
$line = $lines[$line_idx];
$line_idx++;
$line =~ m/^\s*\{\s*$/ || die "Unexpected content: enum should be followed by {\nline: $line";
push @output, "$line\n";
push @output, dbg("ENU2")."$line\n";
while ($line_idx < $line_count){
$line = $lines[$line_idx];
$line_idx++;
if ($line =~ m/\};/){
last;
}
$line =~ s/(\s*\w+)(\s*=\s*[\w\s\d<|]+.*?)?(,?).*$/$1$3/;
push @output, "$line\n";
push @output, dbg("ENU3")."$line\n";
}
push @output, "$line\n";
push @output, dbg("ENU4")."$line\n";
# enums don't have Docstring apparently
$comment = '';
next;
Expand All @@ -386,11 +404,13 @@ sub processDoxygenLine

# skip non-method member declaration in non-public sections
if ( $SIP_RUN != 1 && $ACCESS != PUBLIC && $line =~ m/^\s*(?:mutable\s)?\w+[\w<> *&:,]* \*?\w+( = \w+(\([^()]+\))?)?;/){
dbg_info("skip non-method member declaration in non-public sections");
next;
}

# remove struct member assignment
if ( $SIP_RUN != 1 && $ACCESS == PUBLIC && $line =~ m/^(\s*\w+[\w<> *&:,]* \*?\w+) = \w+(\([^()]+\))?;/ ){
dbg_info("remove struct member assignment");
$line = "$1;";
}

Expand All @@ -417,6 +437,7 @@ sub processDoxygenLine
if ( $MULTILINE_DEFINITION == 1 ){
my $virtual_line = $line;
my $virtual_line_idx = $line_idx;
dbg_info("handle multiline definition to add virtual keyword on opening line");
while ( $virtual_line !~ m/^[^()]*\(([^()]*\([^()]*\)[^()]*)*[^()]*$/){
$virtual_line_idx--;
$virtual_line = $lines[$virtual_line_idx];
Expand All @@ -441,11 +462,14 @@ sub processDoxygenLine

# remove constructor definition, function bodies, member initializing list
if ( $SIP_RUN != 1 && $line =~ m/^(\s*)?(explicit )?(virtual )?(static |const )*(([\w:]+(<.*?>)?\s+(\*|&)?)?(\w+|operator.{1,2})\([\w=()\/ ,&*<>:-]*\)( (?:const|SIP_[A-Z_]*?))*)\s*(\{.*\})?(?!;)(\s*\/\/.*)?$/ ){
dbg_info("remove constructor definition, function bodies, member initializing list");
my $newline = "$1$2$3$4$5;";
if ($line !~ m/\{.*?\}$/){
if ($line !~ m/\{.*?\}\s*(\/\/.*)?$/){
dbg_info(" go for multiline");
$line = $lines[$line_idx];
$line_idx++;
while ( $line =~ m/^\s*[:,] [\w<>]+\(.*?\)/){
dbg_info(" member initializing list");
$line = $lines[$line_idx];
$line_idx++;
}
Expand All @@ -454,7 +478,6 @@ sub processDoxygenLine
while ($line_idx < $line_count){
$line = $lines[$line_idx];
$line_idx++;

$nesting_index += $line =~ tr/\{//;
$nesting_index -= $line =~ tr/\}//;
if ($nesting_index == 0){
Expand Down Expand Up @@ -542,14 +565,16 @@ sub processDoxygenLine
$line =~ s/\s*% (MappedType|TypeCode|TypeHeaderCode|ConvertFromTypeCode|ConvertToTypeCode|MethodCode|End)/%$1/;
$line =~ s/\/\s+GetWrapper\s+\//\/GetWrapper\//;

push @output, "$line\n";
push @output, dbg("NOR")."$line\n";

# multiline definition (parenthesis left open)
if ( $MULTILINE_DEFINITION == 1 ){
if ( $line =~ m/^[^()]*([^()]*\([^()]*\)[^()]*)*\)[^()]*$/){
# see https://regex101.com/r/DN01iM/2
if ( $line =~ m/^([^()]+(\((?:[^()]++|(?1))*\)))*[^()]*\)[^()]*$/){
$MULTILINE_DEFINITION = 0;
# remove potential following body
if ( $lines[$line_idx] =~ m/^\s*\{$/ ){
if ( $SIP_RUN == 0 && $lines[$line_idx] =~ m/^\s*\{$/ ){
dbg_info("remove following body of multiline def");
my $last_line = $line;
my $nesting_index = 0;
while ($line_idx < $line_count){
Expand All @@ -563,8 +588,8 @@ sub processDoxygenLine
}
}
# add missing semi column
pop(@output);
push @output, "$last_line;\n";
my $dummy = pop(@output);
push @output, dbg("MLT")."$last_line;\n";
}
}
else
Expand All @@ -573,6 +598,7 @@ sub processDoxygenLine
}
}
elsif ( $line =~ m/^[^()]+\([^()]*([^()]*\([^()]*\)[^()]*)*[^)]*$/ ){
dbg_info("Mulitline detected");
$MULTILINE_DEFINITION = 1;
next;
}
Expand All @@ -592,14 +618,14 @@ sub processDoxygenLine
# parent class Docstring
}
else {
push @output, "%Docstring\n";
push @output, dbg("CM1")."%Docstring\n";
if ( $comment !~ m/^\s*$/ ){
push @output, "$comment\n";
push @output, dbg("CM2")."$comment\n";
}
if ($return_type ne '' ){
push @output, " :rtype: $return_type\n";
push @output, dbg("CM3")." :rtype: $return_type\n";

This comment has been minimized.

Sign in to view

Copy link
@m-kuhn

m-kuhn May 4, 2017

Member

Would it be possible to scan the parameters to add something like this?

:param arg1: description
:param arg2: description
:type arg1: type description
:type arg1: type description
:return: return description

This comment has been minimized.

Sign in to view

Copy link
@3nids

3nids May 5, 2017

Author Member

I guess so, not easily though.
Another approach would be to scan the args based on the parameters names (\param), which I think would be much easier but not exhaustive.
}
push @output, "%End\n";
push @output, dbg("CM4")."%End\n";
}
$comment = '';
$return_type = '';
Expand Down
14 changes: 14 additions & 0 deletions tests/scripts/sipifyheader.expected.sip
View file
Expand Up @@ -196,6 +196,7 @@ complex default value and type (i.e. containing commas) should be given as a str
:rtype: bool
%End


void multilineBodyAndDefinition( const QList<int,
QString> &list,
QgsVectorLayer *vl,
Expand All @@ -221,6 +222,7 @@ Mulitline body


virtual int overriddenProperty();

virtual int overrideWithoutVirtual();


Expand Down Expand Up @@ -296,6 +298,18 @@ remove argument

void ZshouldBeShown();

void methodCodeWithMultiLineDef();
%MethodCode
if ( QgsWkbTypes::flatType( a0 ) != QgsWkbTypes::Point )
{
multiLineDef( PyExc_ValueError,
QString( "%1 is not nice" ).arg( QgsWkbTypes::displayString( a0 ) ).toUtf8().constData() );
}
else
{
sipCpp = new sipQgsPointV2( a0, a1, a2, a3, a4 );
}
%End

protected:
bool thisShouldBeListed();
Expand Down
16 changes: 15 additions & 1 deletion tests/scripts/sipifyheader.h
View file
Expand Up @@ -160,7 +160,7 @@ class CORE_EXPORT QgsSipifyHeader : public QtClass<QVariant>, private Ui::QgsBas
QgsVectorLayer *vl,
QgsSnappingResult::SnappingType snap_to ) const;

// Adding SIP_SKIP at the end of a line will discard this MethodCode
// Adding SIP_SKIP at the end of a line will discard this line
bool thisShouldBeSkipped() const SIP_SKIP;

void nonAnnotatedMethodFollowingSkip();
Expand Down Expand Up @@ -326,6 +326,20 @@ class CORE_EXPORT QgsSipifyHeader : public QtClass<QVariant>, private Ui::QgsBas
void ZshouldBeShown();
#endif

void methodCodeWithMultiLineDef();
#ifdef SIP_RUN
% MethodCode
if ( QgsWkbTypes::flatType( a0 ) != QgsWkbTypes::Point )
{
multiLineDef( PyExc_ValueError,
QString( "%1 is not nice" ).arg( QgsWkbTypes::displayString( a0 ) ).toUtf8().constData() );
}
else
{
sipCpp = new sipQgsPointV2( a0, a1, a2, a3, a4 );
}
% End
#endif

protected:
bool thisShouldBeListed();
Expand Down

0 comments on commit ce77029

Please sign in to comment.