1 /*
   2  * Copyright (c) 1999, 2020, 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 
  26 package com.sun.tools.javac.util;
  27 
  28 /** An interface containing layout character constants used in Java
  29  *  programs.
  30  *
  31  *  <p><b>This is NOT part of any supported API.
  32  *  If you write code that depends on this, you do so at your own risk.
  33  *  This code and its internal interfaces are subject to change or
  34  *  deletion without notice.</b>
  35  */
  36 public interface LayoutCharacters {
  37 
  38     /** Tabulator column increment.
  39      */
  40     final static int TabInc = 8;
  41 
  42     /** Standard indentation for subdiagnostics
  43      */
  44     final static int DiagInc = 4;
  45 
  46     /** Standard indentation for additional diagnostic lines
  47      */
  48     final static int DetailsInc = 2;
  49 
  50     /** Tabulator character.
  51      */
  52     final static byte TAB   = 0x9;
  53 
  54     /** Line feed character.
  55      */
  56     final static byte LF    = 0xA;
  57 
  58     /** Form feed character.
  59      */
  60     final static byte FF    = 0xC;
  61 
  62     /** Carriage return character.
  63      */
  64     final static byte CR    = 0xD;
  65 
  66     /** End of input character.  Used as a sentinel to denote the
  67      *  character one beyond the last defined character in a
  68      *  source file.
  69      */
  70     final static byte EOI   = 0x1A;
  71 
  72     /** Bump column to the next tab.
  73      */
  74     static int tabulate(int column) {
  75         return (column / TabInc * TabInc) + TabInc;
  76     }
  77 }