/*
** Copyright (c) 2007 D. Richard Hipp
**
** This program is free software; you can redistribute it and/or
** modify it under the terms of the Simplified BSD License (also
** known as the "2-Clause License" or "FreeBSD License".)
** This program 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.
**
** Author contact information:
** drh@hwaci.com
** http://www.hwaci.com/drh/
**
*******************************************************************************
**
** This file contains code used to format and print comments or other
** text on a TTY.
*/
#include "config.h"
#include "comformat.h"
#include <assert.h>
#ifdef _WIN32
# include <windows.h>
#else
# include <termios.h>
#endif
/*
** This is the previous value used by most external callers when they
** needed to specify a default maximum line length to be used with the
** comment_print() function.
*/
#ifndef COMMENT_LEGACY_LINE_LENGTH
# define COMMENT_LEGACY_LINE_LENGTH (78)
#endif
/*
** Given a comment string zText, format that string for printing
** on a TTY. Assume that the output cursors is indent spaces from
** the left margin and that a single line can contain no more than
** lineLength characters. Indent all subsequent lines by indent.
**
** Return the number of newlines that are output.
*/
int comment_print(const char *zText, int indent, int lineLength){
int tlen = lineLength - indent;
int len = 0, doIndent = 0, lineCnt = 0;
const char *zLine;
#if defined(_WIN32)
if( lineLength<0 ){
CONSOLE_SCREEN_BUFFER_INFO csbi;
memset(&csbi, 0, sizeof(CONSOLE_SCREEN_BUFFER_INFO));
if( GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi) ){
tlen = csbi.srWindow.Right - csbi.srWindow.Left - indent;
}
}
#elif defined(TIOCGWINSZ)
if( lineLength<0 ){
struct winsize w;
memset(&w, 0, sizeof(struct winsize));
if( ioctl(0, TIOCGWINSZ, &w)!=-1 ){
tlen = w.ws_col - indent;
}
}
#else
if( lineLength<0 ){
/*
** Fallback to using more-or-less the "legacy semantics" of hard-coding
** the maximum line length to a value reasonable for the vast majority
** of supported systems.
*/
tlen = COMMENT_LEGACY_LINE_LENGTH - indent;
}
#endif
if( zText==0 ) zText = "(NULL)";
if( tlen<=0 ){
tlen = strlen(zText);
}
while( fossil_isspace(zText[0]) ){ zText++; }
if( zText[0]==0 ){
if( !doIndent ){
fossil_print("\n");
lineCnt++;
}
return lineCnt;
}
zLine = zText;
for(;;){
if( zText[0]==0 ){
if( doIndent ){
fossil_print("%*s", indent, "");
}
fossil_print("%.*s\n", (int)(zText - zLine), zLine);
lineCnt++;
break;
}
len += ((zText[0]=='\t') ? 8 : 1);
if( zText[0]=='\n' || len>=tlen ){
if( doIndent ){
fossil_print("%*s", indent, "");
}
doIndent = 1;
while( !fossil_isspace(zText[0]) ){ zText--; }
fossil_print("%.*s\n", (int)(zText - zLine), zLine);
lineCnt++;
zLine = zText;
if( !zLine++ ) break;
len = 0;
}
zText++;
}
return lineCnt;
}
/*
**
** COMMAND: test-comment-format
**
** Usage: %fossil test-comment-format ?OPTIONS? PREFIX TEXT ?WIDTH?
**
** Test comment formatting and printing. Use for testing only.
**
** Options:
** --decode Decode the text using the same method used when
** handling the value of a C-card from a manifest.
** --wordbreak This does nothing and is ignored.
*/
void test_comment_format(void){
const char *zPrefix;
char *zText;
int indent, width;
int decode = find_option("decode", 0, 0)!=0;
find_option("wordbreak", 0, 0); /* NOT USED */
if( g.argc!=4 && g.argc!=5 ){
usage("PREFIX TEXT ?WIDTH?");
}
zPrefix = g.argv[2];
if( decode ){
zText = mprintf("%s", g.argv[3]);
defossilize(zText);
}else{
zText = g.argv[3];
}
indent = strlen(zPrefix);
if( g.argc==5 ){
width = atoi(g.argv[4]);
}else{
width = -1; /* automatic */
}
if( indent>0 ){
fossil_print("%s", zPrefix);
}
fossil_print("(%d lines output)\n", comment_print(zText, indent, width));
if( zText!=g.argv[3] ) fossil_free(zText);
}