Artifact 26c0414fd89346d1d1cfda0762fd8fddbca144b1:
File
src/comformat.c
part of check-in
[dbda8d6ce9]
- Initial check-in of m1 sources.
by
drh on
2007-07-21 14:10:57.
0000: 2f 2a 0a 2a 2a 20 43 6f 70 79 72 69 67 68 74 20 /*.** Copyright
0010: 28 63 29 20 32 30 30 37 20 44 2e 20 52 69 63 68 (c) 2007 D. Rich
0020: 61 72 64 20 48 69 70 70 0a 2a 2a 0a 2a 2a 20 54 ard Hipp.**.** T
0030: 68 69 73 20 70 72 6f 67 72 61 6d 20 69 73 20 66 his program is f
0040: 72 65 65 20 73 6f 66 74 77 61 72 65 3b 20 79 6f ree software; yo
0050: 75 20 63 61 6e 20 72 65 64 69 73 74 72 69 62 75 u can redistribu
0060: 74 65 20 69 74 20 61 6e 64 2f 6f 72 0a 2a 2a 20 te it and/or.**
0070: 6d 6f 64 69 66 79 20 69 74 20 75 6e 64 65 72 20 modify it under
0080: 74 68 65 20 74 65 72 6d 73 20 6f 66 20 74 68 65 the terms of the
0090: 20 47 4e 55 20 47 65 6e 65 72 61 6c 20 50 75 62 GNU General Pub
00a0: 6c 69 63 0a 2a 2a 20 4c 69 63 65 6e 73 65 20 76 lic.** License v
00b0: 65 72 73 69 6f 6e 20 32 20 61 73 20 70 75 62 6c ersion 2 as publ
00c0: 69 73 68 65 64 20 62 79 20 74 68 65 20 46 72 65 ished by the Fre
00d0: 65 20 53 6f 66 74 77 61 72 65 20 46 6f 75 6e 64 e Software Found
00e0: 61 74 69 6f 6e 2e 0a 2a 2a 0a 2a 2a 20 54 68 69 ation..**.** Thi
00f0: 73 20 70 72 6f 67 72 61 6d 20 69 73 20 64 69 73 s program is dis
0100: 74 72 69 62 75 74 65 64 20 69 6e 20 74 68 65 20 tributed in the
0110: 68 6f 70 65 20 74 68 61 74 20 69 74 20 77 69 6c hope that it wil
0120: 6c 20 62 65 20 75 73 65 66 75 6c 2c 0a 2a 2a 20 l be useful,.**
0130: 62 75 74 20 57 49 54 48 4f 55 54 20 41 4e 59 20 but WITHOUT ANY
0140: 57 41 52 52 41 4e 54 59 3b 20 77 69 74 68 6f 75 WARRANTY; withou
0150: 74 20 65 76 65 6e 20 74 68 65 20 69 6d 70 6c 69 t even the impli
0160: 65 64 20 77 61 72 72 61 6e 74 79 20 6f 66 0a 2a ed warranty of.*
0170: 2a 20 4d 45 52 43 48 41 4e 54 41 42 49 4c 49 54 * MERCHANTABILIT
0180: 59 20 6f 72 20 46 49 54 4e 45 53 53 20 46 4f 52 Y or FITNESS FOR
0190: 20 41 20 50 41 52 54 49 43 55 4c 41 52 20 50 55 A PARTICULAR PU
01a0: 52 50 4f 53 45 2e 20 20 53 65 65 20 74 68 65 20 RPOSE. See the
01b0: 47 4e 55 0a 2a 2a 20 47 65 6e 65 72 61 6c 20 50 GNU.** General P
01c0: 75 62 6c 69 63 20 4c 69 63 65 6e 73 65 20 66 6f ublic License fo
01d0: 72 20 6d 6f 72 65 20 64 65 74 61 69 6c 73 2e 0a r more details..
01e0: 2a 2a 20 0a 2a 2a 20 59 6f 75 20 73 68 6f 75 6c ** .** You shoul
01f0: 64 20 68 61 76 65 20 72 65 63 65 69 76 65 64 20 d have received
0200: 61 20 63 6f 70 79 20 6f 66 20 74 68 65 20 47 4e a copy of the GN
0210: 55 20 47 65 6e 65 72 61 6c 20 50 75 62 6c 69 63 U General Public
0220: 0a 2a 2a 20 4c 69 63 65 6e 73 65 20 61 6c 6f 6e .** License alon
0230: 67 20 77 69 74 68 20 74 68 69 73 20 6c 69 62 72 g with this libr
0240: 61 72 79 3b 20 69 66 20 6e 6f 74 2c 20 77 72 69 ary; if not, wri
0250: 74 65 20 74 6f 20 74 68 65 0a 2a 2a 20 46 72 65 te to the.** Fre
0260: 65 20 53 6f 66 74 77 61 72 65 20 46 6f 75 6e 64 e Software Found
0270: 61 74 69 6f 6e 2c 20 49 6e 63 2e 2c 20 35 39 20 ation, Inc., 59
0280: 54 65 6d 70 6c 65 20 50 6c 61 63 65 20 2d 20 53 Temple Place - S
0290: 75 69 74 65 20 33 33 30 2c 0a 2a 2a 20 42 6f 73 uite 330,.** Bos
02a0: 74 6f 6e 2c 20 4d 41 20 20 30 32 31 31 31 2d 31 ton, MA 02111-1
02b0: 33 30 37 2c 20 55 53 41 2e 0a 2a 2a 0a 2a 2a 20 307, USA..**.**
02c0: 41 75 74 68 6f 72 20 63 6f 6e 74 61 63 74 20 69 Author contact i
02d0: 6e 66 6f 72 6d 61 74 69 6f 6e 3a 0a 2a 2a 20 20 nformation:.**
02e0: 20 64 72 68 40 68 77 61 63 69 2e 63 6f 6d 0a 2a drh@hwaci.com.*
02f0: 2a 20 20 20 68 74 74 70 3a 2f 2f 77 77 77 2e 68 * http://www.h
0300: 77 61 63 69 2e 63 6f 6d 2f 64 72 68 2f 0a 2a 2a waci.com/drh/.**
0310: 0a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a .***************
0320: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a ****************
0330: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a ****************
0340: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a ****************
0350: 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a 2a ****************
0360: 0a 2a 2a 0a 2a 2a 20 54 68 69 73 20 66 69 6c 65 .**.** This file
0370: 20 63 6f 6e 74 61 69 6e 73 20 63 6f 64 65 20 75 contains code u
0380: 73 65 64 20 74 6f 20 66 6f 72 6d 61 74 20 61 6e sed to format an
0390: 64 20 70 72 69 6e 74 20 63 6f 6d 6d 65 6e 74 73 d print comments
03a0: 20 6f 72 20 6f 74 68 65 72 0a 2a 2a 20 74 65 78 or other.** tex
03b0: 74 20 6f 6e 20 61 20 54 54 59 2e 0a 2a 2f 0a 23 t on a TTY..*/.#
03c0: 69 6e 63 6c 75 64 65 20 22 63 6f 6e 66 69 67 2e include "config.
03d0: 68 22 0a 23 69 6e 63 6c 75 64 65 20 22 63 6f 6d h".#include "com
03e0: 66 6f 72 6d 61 74 2e 68 22 0a 23 69 6e 63 6c 75 format.h".#inclu
03f0: 64 65 20 3c 61 73 73 65 72 74 2e 68 3e 0a 0a 2f de <assert.h>../
0400: 2a 0a 2a 2a 20 47 69 76 65 6e 20 61 20 63 6f 6d *.** Given a com
0410: 6d 65 6e 74 20 73 74 72 69 6e 67 20 7a 54 65 78 ment string zTex
0420: 74 2c 20 66 6f 72 6d 61 74 20 74 68 61 74 20 73 t, format that s
0430: 74 72 69 6e 67 20 66 6f 72 20 70 72 69 6e 74 69 tring for printi
0440: 6e 67 0a 2a 2a 20 6f 6e 20 61 20 54 54 59 2e 20 ng.** on a TTY.
0450: 20 41 73 73 75 6d 65 20 74 68 61 74 20 74 68 65 Assume that the
0460: 20 6f 75 74 70 75 74 20 63 75 72 73 6f 72 73 20 output cursors
0470: 69 73 20 69 6e 64 65 6e 74 20 73 70 61 63 65 73 is indent spaces
0480: 20 66 72 6f 6d 0a 2a 2a 20 74 68 65 20 6c 65 66 from.** the lef
0490: 74 20 6d 61 72 67 69 6e 20 61 6e 64 20 74 68 61 t margin and tha
04a0: 74 20 61 20 73 69 6e 67 6c 65 20 6c 69 6e 65 20 t a single line
04b0: 63 61 6e 20 63 6f 6e 74 61 69 6e 20 6e 6f 20 6d can contain no m
04c0: 6f 72 65 20 74 68 61 6e 0a 2a 2a 20 6c 69 6e 65 ore than.** line
04d0: 4c 65 6e 67 74 68 20 63 68 61 72 61 63 74 65 72 Length character
04e0: 73 2e 20 20 49 6e 64 65 6e 74 20 61 6c 6c 20 73 s. Indent all s
04f0: 75 62 73 65 71 75 65 6e 74 20 6c 69 6e 65 73 20 ubsequent lines
0500: 62 79 20 69 6e 64 65 6e 74 2e 0a 2a 2a 0a 2a 2a by indent..**.**
0510: 20 6c 69 6e 65 4c 65 6e 67 74 68 20 6d 75 73 74 lineLength must
0520: 20 62 65 20 6c 65 73 73 20 74 68 61 6e 20 34 30 be less than 40
0530: 30 2e 0a 2a 2a 0a 2a 2a 20 52 65 74 75 72 6e 20 0..**.** Return
0540: 74 68 65 20 6e 75 6d 62 65 72 20 6f 66 20 6e 65 the number of ne
0550: 77 6c 69 6e 65 73 20 74 68 61 74 20 61 72 65 20 wlines that are
0560: 6f 75 74 70 75 74 2e 0a 2a 2f 0a 69 6e 74 20 63 output..*/.int c
0570: 6f 6d 6d 65 6e 74 5f 70 72 69 6e 74 28 63 6f 6e omment_print(con
0580: 73 74 20 63 68 61 72 20 2a 7a 54 65 78 74 2c 20 st char *zText,
0590: 69 6e 74 20 69 6e 64 65 6e 74 2c 20 69 6e 74 20 int indent, int
05a0: 6c 69 6e 65 4c 65 6e 67 74 68 29 7b 0a 20 20 69 lineLength){. i
05b0: 6e 74 20 74 6c 65 6e 20 3d 20 6c 69 6e 65 4c 65 nt tlen = lineLe
05c0: 6e 67 74 68 20 2d 20 69 6e 64 65 6e 74 3b 0a 20 ngth - indent;.
05d0: 20 69 6e 74 20 73 69 2c 20 73 6b 2c 20 69 2c 20 int si, sk, i,
05e0: 6b 3b 0a 20 20 69 6e 74 20 64 6f 49 6e 64 65 6e k;. int doInden
05f0: 74 20 3d 20 30 3b 0a 20 20 63 68 61 72 20 7a 42 t = 0;. char zB
0600: 75 66 5b 34 30 30 5d 3b 0a 20 20 69 6e 74 20 6c uf[400];. int l
0610: 69 6e 65 43 6e 74 20 3d 20 30 3b 20 0a 0a 20 20 ineCnt = 0; ..
0620: 66 6f 72 28 3b 3b 29 7b 0a 20 20 20 20 77 68 69 for(;;){. whi
0630: 6c 65 28 20 69 73 73 70 61 63 65 28 7a 54 65 78 le( isspace(zTex
0640: 74 5b 30 5d 29 20 29 7b 20 7a 54 65 78 74 2b 2b t[0]) ){ zText++
0650: 3b 20 7d 0a 20 20 20 20 69 66 28 20 7a 54 65 78 ; }. if( zTex
0660: 74 5b 30 5d 3d 3d 30 20 29 7b 0a 20 20 20 20 20 t[0]==0 ){.
0670: 20 69 66 28 20 64 6f 49 6e 64 65 6e 74 3d 3d 30 if( doIndent==0
0680: 20 29 7b 0a 20 20 20 20 20 20 20 20 70 72 69 6e ){. prin
0690: 74 66 28 22 5c 6e 22 29 3b 0a 20 20 20 20 20 20 tf("\n");.
06a0: 20 20 6c 69 6e 65 43 6e 74 20 3d 20 31 3b 0a 20 lineCnt = 1;.
06b0: 20 20 20 20 20 7d 0a 20 20 20 20 20 20 72 65 74 }. ret
06c0: 75 72 6e 20 6c 69 6e 65 43 6e 74 3b 0a 20 20 20 urn lineCnt;.
06d0: 20 7d 0a 20 20 20 20 66 6f 72 28 73 6b 3d 73 69 }. for(sk=si
06e0: 3d 69 3d 6b 3d 30 3b 20 7a 54 65 78 74 5b 69 5d =i=k=0; zText[i]
06f0: 20 26 26 20 6b 3c 74 6c 65 6e 3b 20 69 2b 2b 29 && k<tlen; i++)
0700: 7b 0a 20 20 20 20 20 20 63 68 61 72 20 63 20 3d {. char c =
0710: 20 7a 54 65 78 74 5b 69 5d 3b 0a 20 20 20 20 20 zText[i];.
0720: 20 69 66 28 20 69 73 73 70 61 63 65 28 63 29 20 if( isspace(c)
0730: 29 7b 0a 20 20 20 20 20 20 20 20 73 69 20 3d 20 ){. si =
0740: 69 3b 0a 20 20 20 20 20 20 20 20 73 6b 20 3d 20 i;. sk =
0750: 6b 3b 0a 20 20 20 20 20 20 20 20 69 66 28 20 6b k;. if( k
0760: 3d 3d 30 20 7c 7c 20 7a 42 75 66 5b 6b 2d 31 5d ==0 || zBuf[k-1]
0770: 21 3d 27 20 27 20 29 7b 0a 20 20 20 20 20 20 20 !=' ' ){.
0780: 20 20 20 7a 42 75 66 5b 6b 2b 2b 5d 20 3d 20 27 zBuf[k++] = '
0790: 20 27 3b 0a 20 20 20 20 20 20 20 20 7d 0a 20 20 ';. }.
07a0: 20 20 20 20 7d 65 6c 73 65 7b 0a 20 20 20 20 20 }else{.
07b0: 20 20 20 7a 42 75 66 5b 6b 5d 20 3d 20 63 3b 0a zBuf[k] = c;.
07c0: 20 20 20 20 20 20 20 20 69 66 28 20 63 3d 3d 27 if( c=='
07d0: 2d 27 20 26 26 20 6b 3e 30 20 26 26 20 69 73 61 -' && k>0 && isa
07e0: 6c 70 68 61 28 7a 42 75 66 5b 6b 2d 31 5d 29 20 lpha(zBuf[k-1])
07f0: 29 7b 0a 20 20 20 20 20 20 20 20 20 20 73 69 20 ){. si
0800: 3d 20 69 2b 31 3b 0a 20 20 20 20 20 20 20 20 20 = i+1;.
0810: 20 73 6b 20 3d 20 6b 2b 31 3b 0a 20 20 20 20 20 sk = k+1;.
0820: 20 20 20 7d 0a 20 20 20 20 20 20 20 20 6b 2b 2b }. k++
0830: 3b 0a 20 20 20 20 20 20 7d 0a 20 20 20 20 7d 0a ;. }. }.
0840: 20 20 20 20 69 66 28 20 64 6f 49 6e 64 65 6e 74 if( doIndent
0850: 20 29 7b 0a 20 20 20 20 20 20 70 72 69 6e 74 66 ){. printf
0860: 28 22 25 2a 73 22 2c 20 69 6e 64 65 6e 74 2c 20 ("%*s", indent,
0870: 22 22 29 3b 0a 20 20 20 20 7d 0a 20 20 20 20 64 "");. }. d
0880: 6f 49 6e 64 65 6e 74 20 3d 20 31 3b 0a 20 20 20 oIndent = 1;.
0890: 20 69 66 28 20 73 6b 3e 30 20 26 26 20 7a 54 65 if( sk>0 && zTe
08a0: 78 74 5b 69 5d 20 29 7b 0a 20 20 20 20 20 20 7a xt[i] ){. z
08b0: 54 65 78 74 20 2b 3d 20 73 69 3b 0a 20 20 20 20 Text += si;.
08c0: 20 20 7a 42 75 66 5b 73 6b 2b 2b 5d 20 3d 20 20 zBuf[sk++] =
08d0: 27 5c 6e 27 3b 0a 20 20 20 20 20 20 7a 42 75 66 '\n';. zBuf
08e0: 5b 73 6b 5d 20 3d 20 30 3b 0a 20 20 20 20 20 20 [sk] = 0;.
08f0: 70 72 69 6e 74 66 28 22 25 73 22 2c 20 7a 42 75 printf("%s", zBu
0900: 66 29 3b 0a 20 20 20 20 7d 65 6c 73 65 7b 0a 20 f);. }else{.
0910: 20 20 20 20 20 7a 54 65 78 74 20 2b 3d 20 69 3b zText += i;
0920: 0a 20 20 20 20 20 20 7a 42 75 66 5b 6b 2b 2b 5d . zBuf[k++]
0930: 20 3d 20 20 27 5c 6e 27 3b 0a 20 20 20 20 20 20 = '\n';.
0940: 7a 42 75 66 5b 6b 5d 20 3d 20 30 3b 0a 20 20 20 zBuf[k] = 0;.
0950: 20 20 20 70 72 69 6e 74 66 28 22 25 73 22 2c 20 printf("%s",
0960: 7a 42 75 66 29 3b 0a 20 20 20 20 7d 0a 20 20 20 zBuf);. }.
0970: 20 6c 69 6e 65 43 6e 74 2b 2b 3b 0a 20 20 7d 0a lineCnt++;. }.
0980: 7d 0a 0a 2f 2a 0a 2a 2a 20 54 65 73 74 20 74 68 }../*.** Test th
0990: 65 20 63 6f 6d 6d 65 6e 74 20 70 72 69 6e 74 69 e comment printi
09a0: 6e 67 0a 2a 2a 0a 2a 2a 20 43 4f 4d 4d 41 4e 44 ng.**.** COMMAND
09b0: 3a 20 74 65 73 74 2d 63 6f 6d 6d 65 6e 74 2d 66 : test-comment-f
09c0: 6f 72 6d 61 74 0a 2a 2f 0a 76 6f 69 64 20 74 65 ormat.*/.void te
09d0: 73 74 5f 63 6f 6d 6d 65 6e 74 5f 66 6f 72 6d 61 st_comment_forma
09e0: 74 28 76 6f 69 64 29 7b 0a 20 20 69 6e 74 20 69 t(void){. int i
09f0: 6e 64 65 6e 74 3b 0a 20 20 69 66 28 20 67 2e 61 ndent;. if( g.a
0a00: 72 67 63 21 3d 34 20 29 7b 0a 20 20 20 20 75 73 rgc!=4 ){. us
0a10: 61 67 65 28 22 50 52 45 46 49 58 20 54 45 58 54 age("PREFIX TEXT
0a20: 22 29 3b 0a 20 20 7d 0a 20 20 69 6e 64 65 6e 74 ");. }. indent
0a30: 20 3d 20 73 74 72 6c 65 6e 28 67 2e 61 72 67 76 = strlen(g.argv
0a40: 5b 32 5d 29 20 2b 20 31 3b 0a 20 20 70 72 69 6e [2]) + 1;. prin
0a50: 74 66 28 22 25 73 20 22 2c 20 67 2e 61 72 67 76 tf("%s ", g.argv
0a60: 5b 32 5d 29 3b 0a 20 20 70 72 69 6e 74 66 28 22 [2]);. printf("
0a70: 28 25 64 20 6c 69 6e 65 73 20 6f 75 74 70 75 74 (%d lines output
0a80: 29 5c 6e 22 2c 20 63 6f 6d 6d 65 6e 74 5f 70 72 )\n", comment_pr
0a90: 69 6e 74 28 67 2e 61 72 67 76 5b 33 5d 2c 20 69 int(g.argv[3], i
0aa0: 6e 64 65 6e 74 2c 20 37 39 29 29 3b 0a 7d 0a ndent, 79));.}.