1917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul/* 2917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Copyright (C) 2007 The Android Open Source Project 3917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 4917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Licensed under the Apache License, Version 2.0 (the "License"); 5917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * you may not use this file except in compliance with the License. 6917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * You may obtain a copy of the License at 7917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 8917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * http://www.apache.org/licenses/LICENSE-2.0 9917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 10917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Unless required by applicable law or agreed to in writing, software 11917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * distributed under the License is distributed on an "AS IS" BASIS, 12917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * See the License for the specific language governing permissions and 14917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * limitations under the License. 15917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 16917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 17917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulpackage com.android.dexgen.util; 18917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 19917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul/** 20917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Interface for a binary output destination that may be augmented 21917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * with textual annotations. 22917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 23917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulpublic interface AnnotatedOutput 24917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul extends Output { 25917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 26917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Get whether this instance will actually keep annotations. 27917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 28917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @return {@code true} iff annotations are being kept 29917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 30917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public boolean annotates(); 31917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 32917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 33917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Get whether this instance is intended to keep verbose annotations. 34917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Annotators may use the result of calling this method to inform their 35917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * annotation activity. 36917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 37917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @return {@code true} iff annotations are to be verbose 38917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 39917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public boolean isVerbose(); 40917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 41917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 42917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Add an annotation for the subsequent output. Any previously 43917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * open annotation will be closed by this call, and the new 44917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * annotation marks all subsequent output until another annotation 45917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * call. 46917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 47917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @param msg {@code non-null;} the annotation message 48917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 49917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public void annotate(String msg); 50917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 51917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 52917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Add an annotation for a specified amount of subsequent 53917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * output. Any previously open annotation will be closed by this 54917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * call. If there is already pending annotation from one or more 55917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * previous calls to this method, the new call "consumes" output 56917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * after all the output covered by the previous calls. 57917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 58917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @param amt {@code >= 0;} the amount of output for this annotation to 59917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * cover 60917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @param msg {@code non-null;} the annotation message 61917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 62917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public void annotate(int amt, String msg); 63917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 64917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 65917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * End the most recent annotation. Subsequent output will be unannotated, 66917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * until the next call to {@link #annotate}. 67917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 68917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public void endAnnotation(); 69917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 70917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 71917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Get the maximum width of the annotated output. This is advisory: 72917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Implementations of this interface are encouraged to deal with too-wide 73917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * output, but annotaters are encouraged to attempt to avoid exceeding 74917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * the indicated width. 75917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 76917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @return {@code >= 1;} the maximum width 77917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 78917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public int getAnnotationWidth(); 79917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul} 80