nextflow.ast.LangHelpers Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nextflow Show documentation
A DSL modelled around the UNIX pipe concept, that simplifies writing parallel and scalable pipelines in a portable manner
There is a newer version: 24.11.0-edge
Show newest version
/*
 * Copyright 2013-2024, Seqera Labs
 *
 * 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 nextflow.ast;

import java.nio.file.Path;

import groovy.transform.CompileStatic;
import groovy.transform.PackageScope;
import nextflow.processor.TaskPath;
import nextflow.util.Duration;
import nextflow.util.PathEscapeAware;
import nextflow.util.MemoryUnit;
import org.codehaus.groovy.runtime.ScriptBytecodeAdapter;
import org.codehaus.groovy.runtime.typehandling.DefaultTypeTransformation;

/**
 * Implements Nextflow DSL helper methods
 *
 * @author Paolo Di Tommaso 
 */
@PackageScope
@CompileStatic
class LangHelpers {

    /**
     * This method is used in place of `==` operator to allow
     * the comparisons of `Path` objects which by default are not supported
     * because it implements the Comparator interface
     *
     * See
     *  {@link ScriptBytecodeAdapter#compareEqual(Object,Object)}
     *  https://stackoverflow.com/questions/28355773/in-groovy-why-does-the-behaviour-of-change-for-interfaces-extending-compar#comment45123447_28387391
     *
     * @param left Left equals operand
     * @param right Right equals operand
     * @return 
     */
    @PackageScope
    static boolean compareEqual( Object left, Object right )  {
        // -- legacy
        if (left==right) return true;
        Class leftClass = left==null?null:left.getClass();
        Class rightClass = right==null?null:right.getClass();
        if (leftClass ==Integer.class && rightClass==Integer.class) {
            return left.equals(right);
        }
        if (leftClass ==Double.class && rightClass==Double.class) {
            return left.equals(right);
        }
        if (leftClass ==Long.class && rightClass==Long.class) {
            return left.equals(right);
        }

        // -- compare Paths
        if( left instanceof Path && right instanceof Path ) {
            return TaskPath.equals((Path)left, (Path)right);
        }
        // -- compare memory unit
        if( left instanceof MemoryUnit ) {
            if( right == null ) return false;
            return MemoryUnit.compareTo((MemoryUnit)left, right)==0;
        }
        if( right instanceof MemoryUnit ) {
            if( left == null ) return false;
            return MemoryUnit.compareTo((MemoryUnit)right, left)==0;
        }
        // -- compare duration
        if( left instanceof Duration) {
            if( right == null ) return false;
            return Duration.compareTo((Duration)left, right)==0;
        }
        if( right instanceof Duration ) {
            if( left == null ) return false;
            return Duration.compareTo((Duration)right, left)==0;
        }

        // -- fallback on default
        return DefaultTypeTransformation.compareEqual(left, right);
    }

    /**
     * Extends default less than comparison provided by {@link ScriptBytecodeAdapter#compareLessThan(Object, Object)}
     *
     * @param left Left operand
     * @param right Right operand
     * @return The comparison result
     */
    static boolean compareLessThan( Object left, Object right ) {
        Class leftClass = left==null?null:left.getClass();
        Class rightClass = right==null?null:right.getClass();
        if (leftClass ==Integer.class && rightClass==Integer.class) {
            return (Integer) left < (Integer) right;
        }
        if (leftClass ==Double.class && rightClass==Double.class) {
            return (Double) left < (Double) right;
        }
        if (leftClass ==Long.class && rightClass==Long.class) {
            return (Long) left < (Long) right;
        }

        // -- compare memory unit
        if( left instanceof MemoryUnit ) {
            if( right == null ) return false;
            return MemoryUnit.compareTo((MemoryUnit)left, right)<0;
        }
        if( right instanceof MemoryUnit ) {
            if( left == null ) return false;
            return MemoryUnit.compareTo((MemoryUnit)right, left)>0;
        }
        // -- compare duration
        if( left instanceof Duration ) {
            if( right == null ) return false;
            return Duration.compareTo((Duration)left, right)<0;
        }
        if( right instanceof Duration ) {
            if( left == null ) return false;
            return Duration.compareTo((Duration)right, left)>0;
        }

        // -- fallback on default
        return ScriptBytecodeAdapter.compareTo(left, right) < 0;
    }

    /**
     * Extends default less than comparison provided by {@link ScriptBytecodeAdapter#compareLessThanEqual(Object, Object)}
     *
     * @param left Left operand
     * @param right Right operand
     * @return The comparison result
     */
    static boolean compareLessThanEqual( Object left, Object right ) {
        Class leftClass = left==null?null:left.getClass();
        Class rightClass = right==null?null:right.getClass();
        if (leftClass ==Integer.class && rightClass==Integer.class) {
            return (Integer) left <= (Integer) right;
        }
        if (leftClass ==Double.class && rightClass==Double.class) {
            return (Double) left <= (Double) right;
        }
        if (leftClass ==Long.class && rightClass==Long.class) {
            return (Long) left <= (Long) right;
        }

        // -- compare memory unit
        if( left instanceof MemoryUnit ) {
            if( right == null ) return false;
            return MemoryUnit.compareTo((MemoryUnit)left, right)<=0;
        }
        if( right instanceof MemoryUnit ) {
            if( left == null ) return false;
            return MemoryUnit.compareTo((MemoryUnit)right, left)>=0;
        }
        // -- compare duration
        if( left instanceof Duration ) {
            if( right == null ) return false;
            return Duration.compareTo((Duration)left, right)<=0;
        }
        if( right instanceof Duration ) {
            if( left == null ) return false;
            return Duration.compareTo((Duration)right, left)>=0;
        }

        // -- fallback on default
        return ScriptBytecodeAdapter.compareTo(left, right) <= 0;
    }

    /**
     * Extends default less than comparison provided by {@link ScriptBytecodeAdapter#compareGreaterThan(Object, Object)}
     *
     * @param left Left operand
     * @param right Right operand
     * @return The comparison result
     */
    static boolean compareGreaterThan( Object left, Object right ) {
        Class leftClass = left==null?null:left.getClass();
        Class rightClass = right==null?null:right.getClass();
        if (leftClass ==Integer.class && rightClass==Integer.class) {
            return (Integer) left > (Integer) right;
        }
        if (leftClass ==Double.class && rightClass==Double.class) {
            return (Double) left > (Double) right;
        }
        if (leftClass ==Long.class && rightClass==Long.class) {
            return (Long) left > (Long) right;
        }

        // -- compare memory unit
        if( left instanceof MemoryUnit ) {
            if( right == null ) return false;
            return MemoryUnit.compareTo((MemoryUnit)left, right)>0;
        }
        if( right instanceof MemoryUnit ) {
            if( left == null ) return false;
            return MemoryUnit.compareTo((MemoryUnit)right, left)<0;
        }
        // -- compare duration
        if( left instanceof Duration ) {
            if( right == null ) return false;
            return Duration.compareTo((Duration)left, right)>0;
        }
        if( right instanceof Duration ) {
            if( left == null ) return false;
            return Duration.compareTo((Duration)right, left)<0;
        }
        // -- fallback on default
        return ScriptBytecodeAdapter.compareTo(left, right) > 0;
    }

    /**
     * Extends implementation of {@link ScriptBytecodeAdapter#compareGreaterThanEqual(Object, Object)}
     *
     * @param left Left operand
     * @param right Right operand
     * @return The comparison result
     */
    static boolean compareGreaterThanEqual( Object left, Object right ) {
        Class leftClass = left==null?null:left.getClass();
        Class rightClass = right==null?null:right.getClass();
        if (leftClass ==Integer.class && rightClass==Integer.class) {
            return (Integer) left >= (Integer) right;
        }
        if (leftClass ==Double.class && rightClass==Double.class) {
            return (Double) left >= (Double) right;
        }
        if (leftClass ==Long.class && rightClass==Long.class) {
            return (Long) left >= (Long) right;
        }

        // -- compare memory unit
        if( left instanceof MemoryUnit ) {
            if( right == null ) return false;
            return MemoryUnit.compareTo((MemoryUnit)left, right)>=0;
        }
        else if( right instanceof MemoryUnit ) {
            if( left == null ) return false;
            return MemoryUnit.compareTo((MemoryUnit)right, left)<=0;
        }
        // -- compare duration
        if( left instanceof Duration ) {
            if( right == null ) return false;
            return Duration.compareTo((Duration)left, right)>=0;
        }
        else if( right instanceof Duration ) {
            if( left == null ) return false;
            return Duration.compareTo((Duration)right, left)<=0;
        }

        // -- fallback on default 
        return ScriptBytecodeAdapter.compareTo(left, right) >= 0;
    }

    /**
     * Invokes escapes on objects implementing {@link PathEscapeAware}
     * interface
     *
     * {@link TaskCmdXform}, {@link TaskCmdXformVisitor}
     *
     * @param value The value to be rendered
     * @return
     *      A string with path escaped or the original value
     *      if the argument is not implementing the {@link PathEscapeAware} interface
     */
    static Object applyPathEscapeAware(Object value) {
        if( value instanceof PathEscapeAware)
            return ((PathEscapeAware) value).toStringEscape();
        else
            return value;
    }
}