1f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 2f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Copyright (C) 2007 The Android Open Source Project 3f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 4f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 5f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * you may not use this file except in compliance with the License. 6f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * You may obtain a copy of the License at 7f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 8f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 9f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 10f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 11f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 12f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * See the License for the specific language governing permissions and 14f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * limitations under the License. 15f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 16f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 17f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectpackage com.android.dx.util; 18f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 19fe107fb6e3f308ac5174ebdc5a794ee880c741d9Jesse Wilsonimport com.android.dex.util.ByteOutput; 20fe107fb6e3f308ac5174ebdc5a794ee880c741d9Jesse Wilson 21f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/** 22de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * Interface for a sink for binary output. This is similar to 2399409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * {@code java.util.DataOutput}, but no {@code IOExceptions} 24f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * are declared, and multibyte output is defined to be little-endian. 25f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 26bd3dba4346223593ac6033a3d2a7d8ec6f20738bJesse Wilsonpublic interface Output extends ByteOutput { 27f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 28f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Gets the current cursor position. This is the same as the number of 29f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * bytes written to this instance. 30de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 3199409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @return {@code >= 0;} the cursor position 32f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 33f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public int getCursor(); 34f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 35f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 36f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Asserts that the cursor is the given value. 37de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 38f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param expectedCursor the expected cursor value 3999409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @throws RuntimeException thrown if {@code getCursor() != 4099409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * expectedCursor} 41f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 42f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void assertCursor(int expectedCursor); 43de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro 44f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 4599409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * Writes a {@code byte} to this instance. 46de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 47f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param value the value to write; all but the low 8 bits are ignored 48f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 499dbd802c8c96c3a66873bc600bc7d1374a1d08e5Orion Hodson @Override 50f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void writeByte(int value); 51f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 52f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 5399409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * Writes a {@code short} to this instance. 54de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 55f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param value the value to write; all but the low 16 bits are ignored 56f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 57f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void writeShort(int value); 58f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 59f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 6099409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * Writes an {@code int} to this instance. 61de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 62f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param value the value to write 63f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 64f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void writeInt(int value); 65f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 66f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 6799409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * Writes a {@code long} to this instance. 68de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 69f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param value the value to write 70f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 71f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void writeLong(long value); 72f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 73f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 74f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Writes a DWARFv3-style unsigned LEB128 integer. For details, 75f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * see the "Dalvik Executable Format" document or DWARF v3 section 76f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 7.6. 77f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 78f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param value value to write, treated as an unsigned value 7999409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @return {@code 1..5;} the number of bytes actually written 80f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 81dfc5e8e159e7df3efa47d553b7725be22839665dJesse Wilson public int writeUleb128(int value); 82f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 83f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 84f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Writes a DWARFv3-style unsigned LEB128 integer. For details, 85f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * see the "Dalvik Executable Format" document or DWARF v3 section 86f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 7.6. 87f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 88f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param value value to write 8999409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @return {@code 1..5;} the number of bytes actually written 90f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 91dfc5e8e159e7df3efa47d553b7725be22839665dJesse Wilson public int writeSleb128(int value); 92f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 93f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 94f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Writes a {@link ByteArray} to this instance. 95de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 9699409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param bytes {@code non-null;} the array to write 97f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 98f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void write(ByteArray bytes); 99f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 100f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 10199409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * Writes a portion of a {@code byte[]} to this instance. 102de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 10399409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param bytes {@code non-null;} the array to write 10499409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param offset {@code >= 0;} offset into {@code bytes} for the first 105f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * byte to write 10699409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param length {@code >= 0;} number of bytes to write 107f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 108f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void write(byte[] bytes, int offset, int length); 109f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 110f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 11199409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * Writes a {@code byte[]} to this instance. This is just 11299409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * a convenient shorthand for {@code write(bytes, 0, bytes.length)}. 113de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 11499409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param bytes {@code non-null;} the array to write 115f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 116f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void write(byte[] bytes); 117f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 118de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro /** 11999409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * Writes the given number of {@code 0} bytes. 120de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 12199409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param count {@code >= 0;} the number of zeroes to write 122f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 123f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void writeZeroes(int count); 124f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 125de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro /** 12699409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * Adds extra bytes if necessary (with value {@code 0}) to 127f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * force alignment of the output cursor as given. 128de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 12999409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param alignment {@code > 0;} the alignment; must be a power of two 130f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 131f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void alignTo(int alignment); 132f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project} 133