com.igormaznitsa.jcp.directives.ExcludeIfDirectiveHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jcp Show documentation

Powerful multi-pass preprocessor to process directives situated in C-styled commentaries

There is a newer version: 7.1.2

/*
 * Copyright 2002-2019 Igor Maznitsa (http://www.igormaznitsa.com)
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.igormaznitsa.jcp.directives;

import com.igormaznitsa.jcp.context.PreprocessingState;
import com.igormaznitsa.jcp.context.PreprocessorContext;
import java.util.Objects;

/**
 * The class implements the //#excludeif directive handler
 *
 * @author Igor Maznitsa ([email protected])
 */
public class ExcludeIfDirectiveHandler extends AbstractDirectiveHandler {

  @Override

  public String getName() {
    return "excludeif";
  }

  @Override

  public String getReference() {
    return "if argument is TRUE then the file will be ignored by preprocessor";
  }

  @Override
  public boolean isGlobalPhaseAllowed() {
    return true;
  }

  @Override
  public boolean isPreprocessingPhaseAllowed() {
    return false;
  }

  @Override

  public DirectiveArgumentType getArgumentType() {
    return DirectiveArgumentType.BOOLEAN;
  }

  @Override

  public AfterDirectiveProcessingBehaviour execute(final String string,
                                                   final PreprocessorContext context) {
    final PreprocessingState state = context.getPreprocessingState();
    state.pushExcludeIfData(state.getRootFileInfo(), string,
        Objects.requireNonNull(state.peekFile(), "'IF' stack is empty!").getLastReadStringIndex());
    return AfterDirectiveProcessingBehaviour.PROCESSED;
  }
}