lib/RPerl/CodeBlock/Subroutine/Arguments.pm

# [[[ HEADER ]]]
package RPerl::CodeBlock::Subroutine::Arguments;
use strict;
use warnings;
use RPerl::AfterSubclass;
our $VERSION = 0.007_000;

# [[[ OO INHERITANCE ]]]
use parent qw(RPerl::GrammarRule);
use RPerl::GrammarRule;

# [[[ CRITICS ]]]
## no critic qw(ProhibitUselessNoCritic ProhibitMagicNumbers RequireCheckedSyscalls)  # USER DEFAULT 1: allow numeric values & print operator
## no critic qw(RequireInterpolationOfMetachars)  # USER DEFAULT 2: allow single-quoted control characters & sigils

# [[[ INCLUDES ]]]
use Storable qw(dclone);

# [[[ OO PROPERTIES ]]]
our hashref $properties = {};

# [[[ SUBROUTINES & OO METHODS ]]]

sub ast_to_rperl__generate {
    { my string_hashref::method $RETURN_TYPE };
    ( my object $self, my string_hashref $modes) = @ARG;
    my string_hashref $rperl_source_group = { PMC => q{} };
    my string_hashref $rperl_source_subgroup;

#    RPerl::diag( 'in Subroutine::Arguments->ast_to_rperl__generate(), received $self = ' . "\n" . RPerl::Parser::rperl_ast__dump($self) . "\n" );

    my string $lparen_my               = $self->{children}->[0];
    my object $type0                   = $self->{children}->[1];
    my object $name0                   = $self->{children}->[2];
    my object $arguments_star          = $self->{children}->[3];
    my string $rparen                  = $self->{children}->[4];
    my string $equal                   = $self->{children}->[5];
    my string $at_underscore_semicolon = $self->{children}->[6];

    # DEV NOTE, CORRELATION #rp045: identifiers containing underscores may be reserved by C++
    # DEV NOTE: all subroutine arguments are naturally local in scope, thus there is no way to trigger ECOGEASRP183a, it is disabled & unused below
    my string $name0_nosigil = substr $name0, 1;
#    if (((substr $name0_nosigil, 0, 1) eq '_') and ($modes->{_symbol_table}->{_namespace} eq q{}) and ($modes->{_symbol_table}->{_subroutine} eq q{})) {
#        die 'ERROR ECOGEASRP183a, CODE GENERATOR, ABSTRACT SYNTAX TO RPERL:' . "\n" . 'subroutine argument name ' . q{'} . $name0_nosigil . q{'} .
#            ' must not start with an underscore, forbidden by C++ specification as a reserved identifier, dying' . "\n";
#    }
    if ($name0_nosigil =~ m/^_[A-Z]/gxms) {
        die 'ERROR ECOGEASRP183b, CODE GENERATOR, ABSTRACT SYNTAX TO RPERL:' . "\n" . 'subroutine argument name ' . q{'} . $name0_nosigil . q{'} .
            ' must not start with an underscore followed by an uppercase letter, forbidden by C++ specification as a reserved identifier, dying' . "\n";
    }
    elsif ($name0_nosigil =~ m/__/gxms) {
        die 'ERROR ECOGEASRP183c, CODE GENERATOR, ABSTRACT SYNTAX TO RPERL:' . "\n" . 'subroutine argument name ' . q{'} . $name0_nosigil . q{'} .
            ' must not include a double-underscore, forbidden by C++ specification as a reserved identifier, dying' . "\n";
    }

    # CREATE SYMBOL TABLE ENTRY
    $modes->{_symbol_table}->{$modes->{_symbol_table}->{_namespace}}->{$modes->{_symbol_table}->{_subroutine}}->{$name0} = {isa => 'RPerl::CodeBlock::Subroutine::Arguments', type => $type0->{children}->[0]};

    $rperl_source_group->{PMC} .= $lparen_my . q{ };
    $rperl_source_group->{PMC} .= $type0->{children}->[0] . q{ } . $name0;

    # (OP21_LIST_COMMA MY Type VARIABLE_SYMBOL)*
    # NEED FIX: destructive to AST!!!
    while ( exists $arguments_star->{children}->[0] ) {
        my object $comma = shift @{ $arguments_star->{children} };
        my object $my    = shift @{ $arguments_star->{children} };
        my object $type  = shift @{ $arguments_star->{children} };
        my object $name  = shift @{ $arguments_star->{children} };
        $name = $name->{attr};  # strings inside of STAR grammar production becomes TERMINAL object, must retrieve data from attr property

        # DEV NOTE, CORRELATION #rp045: identifiers containing underscores may be reserved by C++
        # DEV NOTE: all subroutine arguments are naturally local in scope, thus there is no way to trigger ECOGEASRP183a, it is disabled & unused below
        my string $name_nosigil = substr $name, 1;
#        if (((substr $name_nosigil, 0, 1) eq '_') and ($modes->{_symbol_table}->{_namespace} eq q{}) and ($modes->{_symbol_table}->{_subroutine} eq q{})) {
#            die 'ERROR ECOGEASRP183a, CODE GENERATOR, ABSTRACT SYNTAX TO RPERL:' . "\n" . 'subroutine argument name ' . q{'} . $name_nosigil . q{'} .
#                ' must not start with an underscore, forbidden by C++ specification as a reserved identifier, dying' . "\n";
#        }
        if ($name_nosigil =~ m/^_[A-Z]/gxms) {
            die 'ERROR ECOGEASRP183b, CODE GENERATOR, ABSTRACT SYNTAX TO RPERL:' . "\n" . 'subroutine argument name ' . q{'} . $name_nosigil . q{'} .
                ' must not start with an underscore followed by an uppercase letter, forbidden by C++ specification as a reserved identifier, dying' . "\n";
        }
        elsif ($name_nosigil =~ m/__/gxms) {
            die 'ERROR ECOGEASRP183c, CODE GENERATOR, ABSTRACT SYNTAX TO RPERL:' . "\n" . 'subroutine argument name ' . q{'} . $name_nosigil . q{'} .
                ' must not include a double-underscore, forbidden by C++ specification as a reserved identifier, dying' . "\n";
        }

        # CREATE SYMBOL TABLE ENTRY
        $modes->{_symbol_table}->{$modes->{_symbol_table}->{_namespace}}->{$modes->{_symbol_table}->{_subroutine}}->{$name} = {isa => 'RPerl::CodeBlock::Subroutine::Arguments', type => $type->{children}->[0]};

        $rperl_source_group->{PMC} .= $comma->{attr} . q{ } . $my->{attr} . q{ } . $type->{children}->[0] . q{ } . $name;
    }

    $rperl_source_group->{PMC} .= q{ } . $rparen . q{ } . $equal . q{ } . $at_underscore_semicolon . "\n";
    return $rperl_source_group;
}

sub ast_to_cpp__generate__CPPOPS_PERLTYPES {
    { my string_hashref::method $RETURN_TYPE };
    ( my object $self, my string_hashref $modes) = @ARG;
    my string_hashref $cpp_source_group = { CPP => q{// <<< RP::CB::S::A __DUMMY_SOURCE_CODE CPPOPS_PERLTYPES >>>} . "\n" };

    #...
    return $cpp_source_group;
}

sub ast_to_cpp__generate__CPPOPS_CPPTYPES {
    { my string_hashref::method $RETURN_TYPE };
    ( my object $self, my string_hashref $modes) = @ARG;
    my string_hashref $cpp_source_group = { CPP => q{} };
    my string_hashref $cpp_source_subgroup;

#    RPerl::diag( 'in Subroutine::Arguments->ast_to_cpp__generate__CPPOPS_CPPTYPES(), received $self = ' . "\n" . RPerl::Parser::rperl_ast__dump($self) . "\n" );

    my object $type0 = $self->{children}->[1]->{children}->[0];  # unwrap $type0 to allow type_convert_perl_to_cpp()
    my string $name0 = $self->{children}->[2];
    my object $arguments_star = $self->{children}->[3];

    # DEV NOTE, CORRELATION #rp045: identifiers containing underscores may be reserved by C++
    # DEV NOTE: all subroutine arguments are naturally local in scope, thus there is no way to trigger ECOGEASRP183a, it is disabled & unused below
    my string $name0_nosigil = substr $name0, 1;
#    if (((substr $name0_nosigil, 0, 1) eq '_') and ($modes->{_symbol_table}->{_namespace} eq q{}) and ($modes->{_symbol_table}->{_subroutine} eq q{})) {
#        die 'ERROR ECOGEASCP183a, CODE GENERATOR, ABSTRACT SYNTAX TO C++:' . "\n" . 'subroutine argument name ' . q{'} . $name0_nosigil . q{'} .
#            ' must not start with an underscore, forbidden by C++ specification as a reserved identifier, dying' . "\n";
#    }
    if ($name0_nosigil =~ m/^_[A-Z]/gxms) {
        die 'ERROR ECOGEASCP183b, CODE GENERATOR, ABSTRACT SYNTAX TO C++:' . "\n" . 'subroutine argument name ' . q{'} . $name0_nosigil . q{'} .
            ' must not start with an underscore followed by an uppercase letter, forbidden by C++ specification as a reserved identifier, dying' . "\n";
    }
    elsif ($name0_nosigil =~ m/__/gxms) {
        die 'ERROR ECOGEASCP183c, CODE GENERATOR, ABSTRACT SYNTAX TO C++:' . "\n" . 'subroutine argument name ' . q{'} . $name0_nosigil . q{'} .
            ' must not include a double-underscore, forbidden by C++ specification as a reserved identifier, dying' . "\n";
    }

    substr $name0, 0, 1, q{};            # remove leading $ sigil

#    RPerl::diag( 'in Subroutine::Arguments->ast_to_cpp__generate__CPPOPS_CPPTYPES(), have $type0 = ' . "\n" . RPerl::Parser::rperl_ast__dump($type0) . "\n" );
#    RPerl::diag( 'in Subroutine::Arguments->ast_to_cpp__generate__CPPOPS_CPPTYPES(), have $name0 = ' . "\n" . RPerl::Parser::rperl_ast__dump($name0) . "\n" );
#    RPerl::diag( 'in Subroutine::Arguments->ast_to_cpp__generate__CPPOPS_CPPTYPES(), have $arguments_star = ' . "\n" . RPerl::Parser::rperl_ast__dump($arguments_star) . "\n" );

    # CREATE SYMBOL TABLE ENTRY
    $type0 = RPerl::Generator::type_convert_perl_to_cpp($type0, 1);  # $pointerify_classes = 1
    # add converted C++ type to symtab entry
    $modes->{_symbol_table}->{$modes->{_symbol_table}->{_namespace}}->{$modes->{_symbol_table}->{_subroutine}}->{$name0} = {isa => 'RPerl::CodeBlock::Subroutine::Arguments', type => $type0};

    my string_arrayref $arguments = [];
    push @{$arguments}, ( $type0 . q{ } . $name0 );

    # (OP21_LIST_COMMA MY Type VARIABLE_SYMBOL)*
    my object $arguments_star_dclone = dclone($arguments_star);
    while ( exists $arguments_star_dclone->{children}->[0] ) {
        shift @{ $arguments_star_dclone->{children} };    # discard $comma
        shift @{ $arguments_star_dclone->{children} };    # discard $my
        my object $type = shift @{ $arguments_star_dclone->{children} };
        $type = $type->{children}->[0];  # unwrap $type to allow type_convert_perl_to_cpp()
        my object $name = shift @{ $arguments_star_dclone->{children} };
        $name = $name->{attr};  # strings inside of STAR grammar production becomes TERMINAL object, must retrieve data from attr property

        # DEV NOTE, CORRELATION #rp045: identifiers containing underscores may be reserved by C++
        # DEV NOTE: all subroutine arguments are naturally local in scope, thus there is no way to trigger ECOGEASRP183a, it is disabled & unused below
        my string $name_nosigil = substr $name, 1;
#        if (((substr $name_nosigil, 0, 1) eq '_') and ($modes->{_symbol_table}->{_namespace} eq q{}) and ($modes->{_symbol_table}->{_subroutine} eq q{})) {
#            die 'ERROR ECOGEASCP183a, CODE GENERATOR, ABSTRACT SYNTAX TO C++:' . "\n" . 'subroutine argument name ' . q{'} . $name_nosigil . q{'} .
#                ' must not start with an underscore, forbidden by C++ specification as a reserved identifier, dying' . "\n";
#        }
        if ($name_nosigil =~ m/^_[A-Z]/gxms) {
            die 'ERROR ECOGEASCP183b, CODE GENERATOR, ABSTRACT SYNTAX TO C++:' . "\n" . 'subroutine argument name ' . q{'} . $name_nosigil . q{'} .
                ' must not start with an underscore followed by an uppercase letter, forbidden by C++ specification as a reserved identifier, dying' . "\n";
        }
        elsif ($name_nosigil =~ m/__/gxms) {
            die 'ERROR ECOGEASCP183c, CODE GENERATOR, ABSTRACT SYNTAX TO C++:' . "\n" . 'subroutine argument name ' . q{'} . $name_nosigil . q{'} .
                ' must not include a double-underscore, forbidden by C++ specification as a reserved identifier, dying' . "\n";
        }

        substr $name, 0, 1, q{};            # remove leading $ sigil
#        RPerl::diag( 'in Subroutine->ast_to_cpp__generate__CPPOPS_CPPTYPES(), have $name = ' . "\n" . RPerl::Parser::rperl_ast__dump($name) . "\n" );

        # CREATE SYMBOL TABLE ENTRY
        $type = RPerl::Generator::type_convert_perl_to_cpp($type, 1);  # $pointerify_classes = 1
        # add converted C++ type to symtab entry
        $modes->{_symbol_table}->{$modes->{_symbol_table}->{_namespace}}->{$modes->{_symbol_table}->{_subroutine}}->{$name} = {isa => 'RPerl::CodeBlock::Subroutine::Arguments', type => $type};

        push @{$arguments}, ( $type . q{ } . $name );
    }
    $cpp_source_group->{CPP} .= join ', ', @{$arguments};
    return $cpp_source_group;
}

1;    # end of class
	Global
`s`	Focus search bar
`?`	Bring up this help dialog
	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)
	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse
	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)