com.overzealous.remark.convert.Codeblock Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of remark Show documentation
markdown generator from html updated but based on original Apache 2.0 licensed code from https://bitbucket.org/OverZealous/remark/src/default/
There is a newer version: 2.0.18
Show newest version
/**
 * (c) Copyright 2019-2020 IBM Corporation
 * 1 New Orchard Road, 
 * Armonk, New York, 10504-1722
 * United States
 * +1 914 499 1900
 * support: Nathaniel Mills [email protected]
 *
 * 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.
 *
 */

/*
 * Copyright 2011 OverZealous Creations, LLC
 *
 * 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.overzealous.remark.convert;

import org.jsoup.nodes.Element;
import org.jsoup.nodes.Node;
import com.overzealous.remark.Options;
import com.overzealous.remark.util.BlockWriter;
import com.overzealous.remark.util.StringUtils;

/**
 * Handles preformatted sections (pre), renders them as code blocks.
 *
 * @author Phil DeJarnett
 * @author Nathaniel Mills modifications for provenance and level tracking
 */
public class Codeblock extends AbstractNodeHandler {

    /**
     * Converts a pre-formatted block of code. Depending on the options, this
     * may render as a block with four spaces added to the beginning, or as a
     * fenced code block.
     *
     * @param parent
     *            The previous node walker, in case we just want to remove an
     *            element.
     * @param node
     *            Node to handle
     * @param converter
     *            Parent converter for this object.
     * @param pw
     *            Provenance Writer to receive provenance annotations mapping
     *            generated markdown to document element(s)
     * @param baseUri
     *            the base URI needed to flesh out partial (local) image or href
     *            URL references
     * @param domain
     *            the domain from the baseUri used to find domain specific
     *            filtering rules
     * @param level
     * @param searchLevel
     * @return the Node where level matches searchLevel, otherwise, returns null
     */
    public Node handleNode(NodeHandler parent, Element node,
        DocumentConverter converter, ProvenanceWriter pw, String baseUri,
        String domain, String level, String searchLevel) {
        Node result = null;
        BlockWriter out;
        Options.FencedCodeBlocks fenced = converter.options
            .getFencedCodeBlocks();
        if (fenced.isEnabled()) {
            String fence = StringUtils.multiply(fenced.getSeparatorCharacter(),
                converter.options.fencedCodeBlocksWidth);
            out = converter.output;
            converter.output.startBlock();
            String md = fence + "\n" + converter.cleaner.cleanCode(node) + "\n"
                + fence;
            out.printAsIs(md);
            saveAnnotation(pw, level, node, md);
            converter.output.endBlock();
        } else {
            converter.output.startBlock();
            out = new BlockWriter(converter.output)
                .setPrependNewlineString("    ");
            String md = converter.cleaner.cleanCode(node);
            out.writeAsIs(md);
            saveAnnotation(pw, level, node, md);
            converter.output.endBlock();
        }
        // no change to level so return null;
        return result;
    }
}