com.phloc.css.reader.errorhandler.LoggingCSSParseErrorHandler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of phloc-css-jdk5 Show documentation
Show all versions of phloc-css-jdk5 Show documentation
phloc CSS parser an other components
/**
* Copyright (C) 2006-2014 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.phloc.css.reader.errorhandler;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.phloc.commons.annotations.Nonempty;
import com.phloc.commons.string.ToStringGenerator;
import com.phloc.css.parser.ParseException;
import com.phloc.css.parser.Token;
/**
* A logging implementation of {@link ICSSParseErrorHandler}. So in case a
* recoverable error occurs, the details are logged to an SLF4J logger.
*
* @author Philip Helger
*/
@Immutable
public class LoggingCSSParseErrorHandler implements ICSSParseErrorHandler
{
private static final Logger s_aLogger = LoggerFactory.getLogger (LoggingCSSParseErrorHandler.class);
private static final int TOKEN_EOF = 0;
private final ICSSParseErrorHandler m_aNestedErrorHandler;
/**
* Default constructor.
*/
public LoggingCSSParseErrorHandler ()
{
this (null);
}
/**
* Constructor with a nested error handler.
*
* @param aNestedErrorHandler
* The nested error handler to be invoked after this error handler. May
* be null to indicate that no nested error handler is
* present.
*/
public LoggingCSSParseErrorHandler (@Nullable final ICSSParseErrorHandler aNestedErrorHandler)
{
m_aNestedErrorHandler = aNestedErrorHandler;
}
@Nonnull
@Nonempty
public static String createLoggingStringParseError (@Nonnull final ParseException ex)
{
if (ex.currentToken == null)
{
// Is null if the constructor with String only was used
return ex.getMessage ();
}
return createLoggingStringParseError (ex.currentToken, ex.expectedTokenSequences, ex.tokenImage, null);
}
/**
* @deprecated Use
* {@link #createLoggingStringParseError(Token,int[][],String[],Token)}
* instead
*/
@Deprecated
@Nonnull
@Nonempty
public static String createLoggingString (@Nonnull final Token aLastValidToken,
@Nonnull final int [][] aExpectedTokenSequencesVal,
@Nonnull final String [] aTokenImageVal,
@Nullable final Token aLastSkippedToken)
{
return createLoggingStringParseError (aLastValidToken,
aExpectedTokenSequencesVal,
aTokenImageVal,
aLastSkippedToken);
}
@Nonnull
@Nonempty
public static String createLoggingStringParseError (@Nonnull final Token aLastValidToken,
@Nonnull final int [][] aExpectedTokenSequencesVal,
@Nonnull final String [] aTokenImageVal,
@Nullable final Token aLastSkippedToken)
{
if (aLastValidToken == null)
throw new NullPointerException ("LastValidToken");
if (aExpectedTokenSequencesVal == null)
throw new NullPointerException ("ExpectedTokenSequencesVal");
if (aTokenImageVal == null)
throw new NullPointerException ("TokenImageVal");
final StringBuilder aExpected = new StringBuilder ();
int nMaxSize = 0;
for (final int [] aExpectedTokens : aExpectedTokenSequencesVal)
{
if (nMaxSize < aExpectedTokens.length)
nMaxSize = aExpectedTokens.length;
if (aExpected.length () > 0)
aExpected.append (',');
for (final int nExpectedToken : aExpectedTokens)
aExpected.append (' ').append (aTokenImageVal[nExpectedToken]);
}
final StringBuilder retval = new StringBuilder (1024);
retval.append ('[')
.append (aLastValidToken.next.beginLine)
.append (':')
.append (aLastValidToken.next.beginColumn)
.append (']');
if (aLastSkippedToken != null)
{
retval.append ("-[")
.append (aLastSkippedToken.endLine)
.append (':')
.append (aLastSkippedToken.endColumn)
.append (']');
}
retval.append (" Encountered");
Token aCurToken = aLastValidToken.next;
for (int i = 0; i < nMaxSize; i++)
{
retval.append (' ');
if (aCurToken.kind == TOKEN_EOF)
{
retval.append (aTokenImageVal[TOKEN_EOF]);
break;
}
retval.append ("text '")
.append (aCurToken.image)
.append ("' corresponding to token ")
.append (aTokenImageVal[aCurToken.kind]);
aCurToken = aCurToken.next;
}
retval.append (". ");
if (aLastSkippedToken != null)
retval.append ("Skipped until token ").append (aLastSkippedToken).append (". ");
retval.append (aExpectedTokenSequencesVal.length == 1 ? "Was expecting:" : "Was expecting one of:")
.append (aExpected);
return retval.toString ();
}
public void onCSSParseError (@Nonnull final Token aLastValidToken,
@Nonnull final int [][] aExpectedTokenSequencesVal,
@Nonnull final String [] aTokenImageVal,
@Nullable final Token aLastSkippedToken) throws ParseException
{
s_aLogger.warn (createLoggingStringParseError (aLastValidToken,
aExpectedTokenSequencesVal,
aTokenImageVal,
aLastSkippedToken));
if (m_aNestedErrorHandler != null)
{
// Invoke nested handler
m_aNestedErrorHandler.onCSSParseError (aLastValidToken,
aExpectedTokenSequencesVal,
aTokenImageVal,
aLastSkippedToken);
}
}
/**
* Create a common string to be used for unexpected rules.
*
* @param aCurrentToken
* The current token that caused an error. Never null.
* @param sRule
* The name of the rule. Always starts with a '@'. May neither be
* null nor empty.
* @param sMsg
* The custom error message. Neither null nor empty.
* @return The concatenated string with source location, rule and message. May
* neither be null nor empty.
*/
@Nonnull
@Nonempty
public static String createLoggingStringUnexpectedRule (@Nonnull final Token aCurrentToken,
@Nonnull @Nonempty final String sRule,
@Nonnull @Nonempty final String sMsg)
{
return "[" +
aCurrentToken.beginLine +
":" +
aCurrentToken.beginColumn +
"] Unexpected rule '" +
sRule +
"': " +
sMsg;
}
public void onCSSUnexpectedRule (@Nonnull final Token aCurrentToken,
@Nonnull @Nonempty final String sRule,
@Nonnull @Nonempty final String sMsg) throws ParseException
{
s_aLogger.warn (createLoggingStringUnexpectedRule (aCurrentToken, sRule, sMsg));
if (m_aNestedErrorHandler != null)
{
// Invoke nested handler
m_aNestedErrorHandler.onCSSUnexpectedRule (aCurrentToken, sRule, sMsg);
}
}
@Override
public String toString ()
{
return new ToStringGenerator (this).toString ();
}
}