/*
 * Copyright (c) 2020, Oracle and/or its affiliates.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of
 * conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other materials provided
 * with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors may be used to
 * endorse or promote products derived from this software without specific prior written
 * permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.oracle.truffle.llvm.runtime.nodes.intrinsics.llvm.va;

import com.oracle.truffle.api.library.GenerateLibrary;
import com.oracle.truffle.api.library.Library;
import com.oracle.truffle.api.library.LibraryFactory;
import com.oracle.truffle.llvm.runtime.types.Type;

This library is a sort of SPI that allows the vararg infrastructure to be split into platform
independent and platform specific code. The platform independent code (residing in
com.oracle.truffle.llvm.runtime.nodes.intrinsics.llvm.va) uses LLVMVaListLibrary to manipulate platform specific va_list managed objects.
See Also:
LLVMVAStart
LLVMVAEnd
LLVMVACopy
LLVMVAArg/**
 * This library is a sort of SPI that allows the vararg infrastructure to be split into platform
 * independent and platform specific code. The platform independent code (residing in
 * <code>com.oracle.truffle.llvm.runtime.nodes.intrinsics.llvm.va</code>) uses
 * {@link LLVMVaListLibrary} to manipulate platform specific <code>va_list</code> managed objects.
 *
 * @see LLVMVAStart
 * @see LLVMVAEnd
 * @see LLVMVACopy
 * @see LLVMVAArg
 */
@GenerateLibrary
public abstract class LLVMVaListLibrary extends Library {

    static final LibraryFactory<LLVMVaListLibrary> FACTORY = LibraryFactory.resolve(LLVMVaListLibrary.class);

    public static LibraryFactory<LLVMVaListLibrary> getFactory() {
        return FACTORY;
    }

    
Initialize the va_list. It corresponds to the va_start macro.
Params:
vaList – 
arguments – 
numberOfExplicitArguments – /**
     * Initialize the va_list. It corresponds to the <code>va_start</code> macro.
     *
     * @param vaList
     * @param arguments
     * @param numberOfExplicitArguments
     */
    public abstract void initialize(Object vaList, Object[] arguments, int numberOfExplicitArguments);

    
Clean up the va_list. It corresponds to the va_end macro.
Params:
vaList – /**
     * Clean up the va_list. It corresponds to the <code>va_end</code> macro.
     *
     * @param vaList
     */
    public abstract void cleanup(Object vaList);

    
Copy the source va_list to the destination va_list. It corresponds to the
va_copy macro.
Params:
srcVaList – 
destVaList – 
numberOfExplicitArguments – /**
     * Copy the source va_list to the destination va_list. It corresponds to the
     * <code>va_copy</code> macro.
     *
     * @param srcVaList
     * @param destVaList
     * @param numberOfExplicitArguments
     */
    public abstract void copy(Object srcVaList, Object destVaList, int numberOfExplicitArguments);

    
Shift the va_list argument to the next argument. It corresponds to the va_arg
macro, if expanded to the LLVM va_arg instruction.
Params:
vaList – the va_list instance
type – the expected argument type
Returns:
the current argument before shifting/**
     * Shift the va_list argument to the next argument. It corresponds to the <code>va_arg</code>
     * macro, if expanded to the LLVM <code>va_arg</code> instruction.
     *
     * @param vaList the va_list instance
     * @param type the expected argument type
     * @return the current argument before shifting
     */
    public abstract Object shift(Object vaList, Type type);
}