001/*
002 * BridJ - Dynamic and blazing-fast native interop for Java.
003 * http://bridj.googlecode.com/
004 *
005 * Copyright (c) 2010-2013, Olivier Chafik (http://ochafik.com/)
006 * All rights reserved.
007 *
008 * Redistribution and use in source and binary forms, with or without
009 * modification, are permitted provided that the following conditions are met:
010 * 
011 *     * Redistributions of source code must retain the above copyright
012 *       notice, this list of conditions and the following disclaimer.
013 *     * Redistributions in binary form must reproduce the above copyright
014 *       notice, this list of conditions and the following disclaimer in the
015 *       documentation and/or other materials provided with the distribution.
016 *     * Neither the name of Olivier Chafik nor the
017 *       names of its contributors may be used to endorse or promote products
018 *       derived from this software without specific prior written permission.
019 * 
020 * THIS SOFTWARE IS PROVIDED BY OLIVIER CHAFIK AND CONTRIBUTORS ``AS IS'' AND ANY
021 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
022 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
023 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
024 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
025 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
026 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
027 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
028 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
029 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
030 */
031package org.bridj.ann;
032
033import java.lang.annotation.ElementType;
034
035import java.lang.annotation.Inherited;
036import java.lang.annotation.Retention;
037import java.lang.annotation.RetentionPolicy;
038import java.lang.annotation.Target;
039
040/**
041 * Force the method call convention to some value.<br>
042 * Without this annotation, BridJ will do its best to infer the call convention
043 * from the context (C++ method, symbol decoration...)
044 *
045 * @author Olivier Chafik
046 */
047@Retention(RetentionPolicy.RUNTIME)
048@Target({ElementType.METHOD, ElementType.TYPE, ElementType.FIELD, ElementType.PACKAGE, ElementType.PARAMETER, ElementType.CONSTRUCTOR})
049@Inherited
050public @interface Convention {
051
052    /**
053     * Calling convention enums
054     */
055    public enum Style {
056
057        /**
058         * __stdcall convention (specific to Windows x86, won't have any effect
059         * on other platforms)
060         */
061        StdCall,
062        /**
063         * __fastcall convention
064         */
065        FastCall,
066        /**
067         * __cdecl convention (default for regular C functions)
068         */
069        CDecl,
070        Pascal,
071        /**
072         * __clrcall convention (not supported, specific to Windows .NET
073         * mixed-mode assemblies)
074         */
075        CLRCall,
076        /**
077         * __thiscall convention (default for regular C++ methods)
078         */
079        ThisCall
080    }
081
082    Style value();
083}