183b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com/* 283b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * [The "BSD licence"] 300fc68adf2e39aeb9fed35293f2576bbe729ec4bJesusFreke@JesusFreke.com * Copyright (c) 2010 Ben Gruver (JesusFreke) 483b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * All rights reserved. 583b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 683b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * Redistribution and use in source and binary forms, with or without 783b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * modification, are permitted provided that the following conditions 883b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * are met: 983b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 1. Redistributions of source code must retain the above copyright 1083b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * notice, this list of conditions and the following disclaimer. 1183b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 2. Redistributions in binary form must reproduce the above copyright 1283b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * notice, this list of conditions and the following disclaimer in the 1383b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * documentation and/or other materials provided with the distribution. 1483b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 3. The name of the author may not be used to endorse or promote products 1583b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * derived from this software without specific prior written permission. 1683b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 1783b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 1883b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 1983b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 2083b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 2183b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 2283b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2383b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2483b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2583b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 2683b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2783b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com */ 2883b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com 2983b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.compackage org.jf.dexlib.Util; 3083b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com 3183b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com/** 3283b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * Interface for a sink for binary output. This is similar to 3383b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * <code>java.util.DataOutput</code>, but no <code>IOExceptions</code> 3483b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * are declared, and multibyte output is defined to be little-endian. 3583b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com */ 3683b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.compublic interface Output { 3783b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com /** 3883b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * Gets the current cursor position. This is the same as the number of 3983b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * bytes written to this instance. 4083b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 4183b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * @return >= 0; the cursor position 4283b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com */ 4383b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com public int getCursor(); 4483b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com 4583b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com /** 4683b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * Asserts that the cursor is the given value. 4783b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 4883b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * @param expectedCursor the expected cursor value 4983b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * @throws RuntimeException thrown if <code>getCursor() != 5083b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * expectedCursor</code> 5183b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com */ 5283b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com public void assertCursor(int expectedCursor); 5383b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com 5483b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com /** 5583b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * Writes a <code>byte</code> to this instance. 5683b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 5783b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * @param value the value to write; all but the low 8 bits are ignored 5883b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com */ 5983b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com public void writeByte(int value); 6083b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com 6183b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com /** 6283b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * Writes a <code>short</code> to this instance. 6383b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 6483b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * @param value the value to write; all but the low 16 bits are ignored 6583b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com */ 6683b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com public void writeShort(int value); 6783b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com 6883b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com /** 6983b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * Writes an <code>int</code> to this instance. 7083b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 7183b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * @param value the value to write 7283b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com */ 7383b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com public void writeInt(int value); 7483b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com 7583b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com /** 7683b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * Writes a <code>long</code> to this instance. 7783b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 7883b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * @param value the value to write 7983b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com */ 8083b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com public void writeLong(long value); 8183b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com 8283b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com /** 8383b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * Writes a DWARFv3-style unsigned LEB128 integer. For details, 8483b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * see the "Dalvik Executable Format" document or DWARF v3 section 8583b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 7.6. 8683b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 8783b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * @param value value to write, treated as an unsigned value 8883b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * @return 1..5; the number of bytes actually written 8983b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com */ 9083b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com public int writeUnsignedLeb128(int value); 9183b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com 9283b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com /** 9383b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * Writes a DWARFv3-style unsigned LEB128 integer. For details, 9483b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * see the "Dalvik Executable Format" document or DWARF v3 section 9583b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 7.6. 9683b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 9783b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * @param value value to write 9883b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * @return 1..5; the number of bytes actually written 9983b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com */ 10083b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com public int writeSignedLeb128(int value); 10183b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com 10283b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com /** 10383b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * Writes a {@link org.jf.dexlib.Util.ByteArray} to this instance. 10483b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 10583b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * @param bytes non-null; the array to write 10683b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com */ 10783b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com public void write(ByteArray bytes); 10883b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com 10983b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com /** 11083b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * Writes a portion of a <code>byte[]</code> to this instance. 11183b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 11283b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * @param bytes non-null; the array to write 11383b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * @param offset >= 0; offset into <code>bytes</code> for the first 11483b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * byte to write 11583b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * @param length >= 0; number of bytes to write 11683b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com */ 11783b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com public void write(byte[] bytes, int offset, int length); 11883b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com 11983b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com /** 12083b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * Writes a <code>byte[]</code> to this instance. This is just 12183b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * a convenient shorthand for <code>write(bytes, 0, bytes.length)</code>. 12283b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 12383b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * @param bytes non-null; the array to write 12483b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com */ 12583b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com public void write(byte[] bytes); 12683b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com 12783b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com /** 12883b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * Writes the given number of <code>0</code> bytes. 12983b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 13083b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * @param count >= 0; the number of zeroes to write 13183b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com */ 13283b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com public void writeZeroes(int count); 13383b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com 13483b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com /** 13583b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * Adds extra bytes if necessary (with value <code>0</code>) to 13683b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * force alignment of the output cursor as given. 13783b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * 13883b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com * @param alignment > 0; the alignment; must be a power of two 13983b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com */ 14083b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com public void alignTo(int alignment); 14183b80f81d311b233188c281059aad4a9f5e8b4e6JesusFreke@JesusFreke.com}