Package org.fife.rsta.ac.perl

Class PerlParser

  • All Implemented Interfaces:
    org.fife.ui.rsyntaxtextarea.parser.Parser
    public class PerlParser
extends org.fife.ui.rsyntaxtextarea.parser.AbstractParser
    Parses Perl code in an RSyntaxTextArea.

    Please keep in mind that this class is a work-in-progress!

    Version:
    0.6

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static int MAX_COMPILE_MILLIS
      The maximum amount of time to wait for Perl to finish compiling a source file.
      private java.lang.String perl5LibOverride
      The user's requested value for PERL5LIB when parsing Perl code, or null to use the default.
      private java.lang.String[] perlEnvironment
      The environment to use when launching Perl to parse code, in the format expected by Runtime.exec().
      private org.fife.ui.rsyntaxtextarea.parser.DefaultParseResult result  
      private boolean taintModeEnabled  
      private boolean warningsEnabled  

    • Constructor Summary

      Constructors 
      Constructor Description
      PerlParser()
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private void createPerlEnvironment()
      Creates the array of environment variables to use when running Perl to syntax check code, based on the user's requested PERL5LIB.
      java.lang.String getPerl5LibOverride()
      Returns the value to use for PERL5LIB when parsing Perl code.
      boolean getWarningsEnabled()
      Returns whether warnings are enabled when checking syntax.
      boolean isTaintModeEnabled()
      Returns whether taint mode is enabled when checking syntax.
      org.fife.ui.rsyntaxtextarea.parser.ParseResult parse​(org.fife.ui.rsyntaxtextarea.RSyntaxDocument doc, java.lang.String style)
      void setPerl5LibOverride​(java.lang.String override)
      Sets the value to use for PERL5LIB when parsing Perl code.
      void setTaintModeEnabled​(boolean enabled)
      Toggles whether taint mode is enabled when checking syntax.
      void setWarningsEnabled​(boolean enabled)
      Toggles whether warnings are returned when checking syntax.

      • Methods inherited from class org.fife.ui.rsyntaxtextarea.parser.AbstractParser

        getHyperlinkListener, getImageBase, isEnabled, setEnabled, setHyperlinkListener

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • result

        private org.fife.ui.rsyntaxtextarea.parser.DefaultParseResult result

      • taintModeEnabled

        private boolean taintModeEnabled

      • warningsEnabled

        private boolean warningsEnabled

      • perl5LibOverride

        private java.lang.String perl5LibOverride
        The user's requested value for PERL5LIB when parsing Perl code, or null to use the default.

      • perlEnvironment

        private java.lang.String[] perlEnvironment
        The environment to use when launching Perl to parse code, in the format expected by Runtime.exec(). This may be null.

      • MAX_COMPILE_MILLIS

        private static final int MAX_COMPILE_MILLIS
        The maximum amount of time to wait for Perl to finish compiling a source file.
        See Also:
        Constant Field Values

    • Constructor Detail

      • PerlParser

        public PerlParser()
        Constructor.

    • Method Detail

      • createPerlEnvironment

        private void createPerlEnvironment()
        Creates the array of environment variables to use when running Perl to syntax check code, based on the user's requested PERL5LIB.

      • getPerl5LibOverride

        public java.lang.String getPerl5LibOverride()
        Returns the value to use for PERL5LIB when parsing Perl code.
        Returns:
        The value, or null to use the system default.
        See Also:
        setPerl5LibOverride(String)

      • getWarningsEnabled

        public boolean getWarningsEnabled()
        Returns whether warnings are enabled when checking syntax.
        Returns:
        Whether warnings are enabled.
        See Also:
        setWarningsEnabled(boolean)

      • isTaintModeEnabled

        public boolean isTaintModeEnabled()
        Returns whether taint mode is enabled when checking syntax.
        Returns:
        Whether taint mode is enabled.
        See Also:
        setTaintModeEnabled(boolean)

      • parse

        public org.fife.ui.rsyntaxtextarea.parser.ParseResult parse​(org.fife.ui.rsyntaxtextarea.RSyntaxDocument doc,
                                                            java.lang.String style)

      • setPerl5LibOverride

        public void setPerl5LibOverride​(java.lang.String override)
        Sets the value to use for PERL5LIB when parsing Perl code.
        Parameters:
        override - The value, or null to use the system default.
        See Also:
        getPerl5LibOverride()

      • setTaintModeEnabled

        public void setTaintModeEnabled​(boolean enabled)
        Toggles whether taint mode is enabled when checking syntax.
        Parameters:
        enabled - Whether taint mode should be enabled.
        See Also:
        isTaintModeEnabled()

      • setWarningsEnabled

        public void setWarningsEnabled​(boolean enabled)
        Toggles whether warnings are returned when checking syntax.
        Parameters:
        enabled - Whether warnings are enabled.
        See Also:
        getWarningsEnabled()