de.uni.bremen.monty.moco.codegeneration.context.CommentAppender.java Source code

Introduction

Here is the source code for de.uni.bremen.monty.moco.codegeneration.context.CommentAppender.java

Source

/*
 * moco, the Monty Compiler
 * Copyright (c) 2013-2014, Monty's Coconut, All rights reserved.
 *
 * This file is part of moco, the Monty Compiler.
 *
 * moco is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 3.0 of the License, or (at your option) any later version.
 *
 * moco is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * Linking this program and/or its accompanying libraries statically or
 * dynamically with other modules is making a combined work based on this
 * program. Thus, the terms and conditions of the GNU General Public License
 * cover the whole combination.
 *
 * As a special exception, the copyright holders of moco give
 * you permission to link this programm and/or its accompanying libraries
 * with independent modules to produce an executable, regardless of the
 * license terms of these independent modules, and to copy and distribute the
 * resulting executable under terms of your choice, provided that you also meet,
 * for each linked independent module, the terms and conditions of the
 * license of that module.
 *
 * An independent module is a module which is not
 * derived from or based on this program and/or its accompanying libraries.
 * If you modify this library, you may extend this exception to your version of
 * the program or library, but you are not obliged to do so. If you do not wish
 * to do so, delete this exception statement from your version.
 *
 * You should have received a copy of the GNU General Public
 * License along with this library.
 */
package de.uni.bremen.monty.moco.codegeneration.context;

import de.uni.bremen.monty.moco.ast.ASTNode;
import de.uni.bremen.monty.moco.ast.Position;
import org.apache.commons.lang3.StringUtils;

/** Adds a comment after each line in llvm. That comment contains the Class of the ASTNode and the line in the monty File
 * that is responsible for the llvm instruction. */
public class CommentAppender {

    private ASTNode currentNode;

    /** Adds a comment
     * 
     * @param string
     *            the llvm instruction
     * @return the llvm with comment */
    public String addComment(String string) {
        Position position = currentNode.getPosition();
        StringBuilder builder = new StringBuilder();

        builder.append(StringUtils.rightPad(string, 90));
        builder.append("; ");
        builder.append(currentNode.getClass().getSimpleName());
        builder.append(" in ");
        builder.append(position.getLineNumber());
        builder.append(":");
        builder.append(position.getCharNumber());

        return builder.toString();
    }

    /** Links the LLVM-Instructions to Monty-Nodes
     * 
     * @param currentNode
     *            Node that is currently processed. */
    public void setNode(ASTNode currentNode) {
        this.currentNode = currentNode;
    }
}