(* m2color.def interface to gcc colorization.

Copyright (C) 2019-2023 Free Software Foundation, Inc.
Contributed by Gaius Mulley <gaius@glam.ac.uk>.

This file is part of GNU Modula-2.

GNU Modula-2 is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3, or (at your option)
any later version.

GNU Modula-2 is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Modula-2; see the file COPYING3.  If not see
<http://www.gnu.org/licenses/>.  *)

DEFINITION MODULE FOR "C" m2color ;

FROM SYSTEM IMPORT ADDRESS ;

TYPE
   PtrToChar = POINTER TO CHAR ;


(* colorize_start returns a C string containing the color escape sequences
   mapped onto, name.  See diagnostic-color.c for the definitive
   list of GCC colors.  The name list includes: error, warning,
   note, range1, range2, quote, locus, fixit-insert, fixit-delete,
   diff-filename, diff-hunk, diff-delete, diff-insert, type-diff.  *)

PROCEDURE colorize_start (show_color: BOOLEAN; name: ADDRESS;
                          _name_high: CARDINAL) : PtrToChar ;

(* colorize_stop return a C string containing the escape sequences to
   stop text colorization.  *)

PROCEDURE colorize_stop (show_color: BOOLEAN) : PtrToChar ;


(* open_quote return a C string containing the open quote character which
   might be a UTF-8 character if on a UTF-8 supporting host.  *)

PROCEDURE open_quote () : PtrToChar ;


(* close_quote return a C string containing the close quote character which
   might be a UTF-8 character if on a UTF-8 supporting host.  *)

PROCEDURE close_quote () : PtrToChar ;


END m2color.