1/*
2 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package jdk.nashorn.internal.codegen.types;
27
28import jdk.internal.org.objectweb.asm.MethodVisitor;
29
30/**
31 * Numeric operations, not supported by all types
32 */
33interface BytecodeNumericOps {
34
35    /**
36     * Pop and negate the value on top of the stack and push the result
37     *
38     * @param method method visitor
39     * @param programPoint program point id
40     * @return result type
41     */
42    Type neg(MethodVisitor method, int programPoint);
43
44    /**
45     * Pop two values on top of the stack and subtract the first from the
46     * second, pushing the result on the stack
47     *
48     * @param method method visitor
49     * @param programPoint program point id
50     * @return result type
51     */
52    Type sub(MethodVisitor method, int programPoint);
53
54    /**
55     * Pop and multiply the two values on top of the stack and push the result
56     * on the stack
57     *
58     * @param method method visitor
59     * @param programPoint program point id
60     * @return result type
61     */
62    Type mul(MethodVisitor method, int programPoint);
63
64    /**
65     * Pop two values on top of the stack and divide the first with the second,
66     * pushing the result on the stack
67     *
68     * @param method method visitor
69     * @param programPoint program point id
70     * @return result type
71     */
72    Type div(MethodVisitor method, int programPoint);
73
74    /**
75     * Pop two values on top of the stack and compute the modulo of the first
76     * with the second, pushing the result on the stack
77     *
78     * Note that the rem method never takes a program point, because it
79     * can never be more optimistic than its widest operand - an int/int
80     * rem operation or a long/long rem operation can never return a
81     * winder remainder than the int or the long
82     *
83     * @param method method visitor
84     * @param programPoint program point id
85     * @return result type
86     */
87    Type rem(MethodVisitor method, int programPoint);
88
89    /**
90     * Comparison with int return value, e.g. LCMP, DCMP.
91     *
92     * @param method the method visitor
93     * @param isCmpG is this a double style cmpg
94     *
95     * @return int return value
96     */
97    Type cmp(MethodVisitor method, boolean isCmpG);
98}
99