suplib/src/RCSKeyword.i3


 Copyright 1996-2003 John D. Polstra.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgment:
 *      This product includes software developed by John D. Polstra.
 * 4. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * $Id: RCSKeyword.i3.html,v 1.3 2010-04-29 17:20:02 wagner Exp $ 

INTERFACE RCSKeyword;

IMPORT Pathname, RCSDelta, RCSError, RCSString;

EXCEPTION Unknown;

TYPE
  T <: Public;

  Public = OBJECT METHODS
    init(): T;
    alias(newName, oldName: TEXT)
      RAISES {Unknown};
    enable(name: TEXT; enabled := TRUE)
      RAISES {Unknown};
    enableAll(enabled := TRUE);
    expand(iter: RCSString.Iterator;
	   hideAttic: BOOLEAN;
	   cvsRoot: Pathname.T;
	   name: Pathname.T;
	   delta: RCSDelta.T;
	   tag: TEXT := NIL;
	   mode := ExpandMode.Default): RCSString.Iterator;
  END;

  ExpandMode = {
    Default,		(* Whatever mode is specified in the RCS file. *)
    KeyValue,		(* "kv": Keyword and value. *)
    KeyValueLocker,	(* "kvl": Keyword and value, with locker. *)
    Key,		(* "k": Keyword name only. *)
    Old,		(* "o": Whatever is already present in the delta. *)
    Binary,		(* "b": Like Old, but use binary I/O. *)
    Value		(* "v": Value only. *)
  };

PROCEDURE EncodeExpand(x: ExpandMode): TEXT;
Produce a printable representation of the given expansion mode.

PROCEDURE DecodeExpand(t: TEXT): ExpandMode
  RAISES {RCSError.E};
Convert a printable representation into an expansion mode.

END RCSKeyword.