/ 
MarpaX-Languages-C-AST-0.01
River stage zero No dependents
/ MarpaX::Languages::C::AST::Scope

NAME

MarpaX::Languages::C::AST::Scope - Scope management when translating a C source to an AST

VERSION

Version 0.01

SYNOPSIS

This modules manages the scopes when translation a C source into an AST tree. This module is an implementation of the article:

Resolving Typedefs in a Multipass C Compiler

from Journal of C Languages Translation, Volume 2, Number 4, writen by W.M. McKeeman. A online version may be accessed at http://www.cs.dartmouth.edu/~mckeeman/references/JCLT/ResolvingTypedefsInAMultipassCCompiler.pdf.

Example:

use MarpaX::Languages::C::AST::Scope;

my $cAstScopeObject = MarpaX::Languages::C::AST::Scope->new();
$cAstScopeObject->parseEnterScope();
$cAstScopeObject->parseReenterScope();
$cAstScopeObject->parseEnterTypedef("myTypedef");
$cAstScopeObject->parseEnterEnum("myEnum");
$cAstScopeObject->parseObscureTypedef("myVariable");
foreach (qw/myTypedef myEnum myVariable/) {
  if ($cAstScopeObject->parseIsTypedef($_)) {
    print "\"$_\" is a typedef\n";
  } elsif ($cAstScopeObject->parseIsEnum($_)) {
    print "\"$_\" is an enum\n";
  }
}
$cAstScopeObject->parseExitScope();

Please note that this module is logging via Log::Any.

SUBROUTINES/METHODS

new

Instance a new object. Takes no parameter.

parseEnterScope

Say we enter a new scope. Takes no parameter.

parseExitScope

Say we leave current scope. Takes no parameter.

parseReenterScope

Say we re-enter last scope. Takes no parameter.

parseEnterTypedef($token)

Declare a new typedef, that will be visible until current scope is left. Takes the corresponding token value in input.

parseEnterEnum($token)

Declare a new enum, that will be visible at any scope from now on. Takes the corresponding token value in input.

parseObscureTypedef($token)

Obscured a typedef. Takes the corresponding token value in input.

parseIsTypedef($token)

Return a true value if the corresponding token value in input is a typedef. Returns false otherwise.

parseIsEnum($token)

Return a true value if the corresponding token value in input is an enum. Returns false otherwise.

SEE ALSO

Log::Any

AUTHOR

Jean-Damien Durand, <jeandamiendurand at free.fr>

BUGS

Please report any bugs or feature requests to bug-marpax-language-c-ast at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=MarpaX-Languages-C-AST. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc MarpaX::Languages::C::AST

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2013 Jean-Damien Durand.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.