Add preliminary db1.c from Aymeric Vincent <xmimic@free.fr>
[nvi.git] / common / db.c
blob400caf1aa46ebd87549570ce14b61463de91b0ea
1 /*-
2 * Copyright (c) 1992, 1993, 1994
3 * The Regents of the University of California. All rights reserved.
4 * Copyright (c) 1992, 1993, 1994, 1995, 1996
5 * Keith Bostic. All rights reserved.
7 * See the LICENSE file for redistribution information.
8 */
10 #include "config.h"
12 #ifndef lint
13 static const char sccsid[] = "$Id: db.c,v 10.46 2002/03/09 12:48:22 skimo Exp $ (Berkeley) $Date: 2002/03/09 12:48:22 $";
14 #endif /* not lint */
16 #include <sys/types.h>
17 #include <sys/queue.h>
18 #include <sys/time.h>
20 #include <bitstring.h>
21 #include <errno.h>
22 #include <limits.h>
23 #include <stdio.h>
24 #include <string.h>
26 #include "common.h"
27 #include "../vi/vi.h"
29 static int append __P((SCR*, db_recno_t, CHAR_T*, size_t, lnop_t, int));
32 * db_eget --
33 * Front-end to db_get, special case handling for empty files.
35 * PUBLIC: int db_eget __P((SCR *, db_recno_t, CHAR_T **, size_t *, int *));
37 int
38 db_eget(SCR *sp, db_recno_t lno, CHAR_T **pp, size_t *lenp, int *isemptyp)
40 /* Line number. */
41 /* Pointer store. */
42 /* Length store. */
45 db_recno_t l1;
47 if (isemptyp != NULL)
48 *isemptyp = 0;
50 /* If the line exists, simply return it. */
51 if (!db_get(sp, lno, 0, pp, lenp))
52 return (0);
55 * If the user asked for line 0 or line 1, i.e. the only possible
56 * line in an empty file, find the last line of the file; db_last
57 * fails loudly.
59 if ((lno == 0 || lno == 1) && db_last(sp, &l1))
60 return (1);
62 /* If the file isn't empty, fail loudly. */
63 if ((lno != 0 && lno != 1) || l1 != 0) {
64 db_err(sp, lno);
65 return (1);
68 if (isemptyp != NULL)
69 *isemptyp = 1;
71 return (1);
75 * db_get --
76 * Look in the text buffers for a line, followed by the cache, followed
77 * by the database.
79 * PUBLIC: int db_get __P((SCR *, db_recno_t, u_int32_t, CHAR_T **, size_t *));
81 int
82 db_get(SCR *sp, db_recno_t lno, u_int32_t flags, CHAR_T **pp, size_t *lenp)
83 /* Line number. */ /* Pointer store. */ /* Length store. */
85 DBT data, key;
86 EXF *ep;
87 TEXT *tp;
88 db_recno_t l1, l2;
89 CHAR_T *wp;
90 size_t wlen;
91 size_t nlen;
94 * The underlying recno stuff handles zero by returning NULL, but
95 * have to have an OOB condition for the look-aside into the input
96 * buffer anyway.
98 if (lno == 0)
99 goto err1;
101 /* Check for no underlying file. */
102 if ((ep = sp->ep) == NULL) {
103 ex_emsg(sp, NULL, EXM_NOFILEYET);
104 goto err3;
107 if (LF_ISSET(DBG_NOCACHE))
108 goto nocache;
111 * Look-aside into the TEXT buffers and see if the line we want
112 * is there.
114 if (F_ISSET(sp, SC_TINPUT)) {
115 l1 = ((TEXT *)sp->tiq.cqh_first)->lno;
116 l2 = ((TEXT *)sp->tiq.cqh_last)->lno;
117 if (l1 <= lno && l2 >= lno) {
118 #if defined(DEBUG) && 0
119 vtrace(sp,
120 "retrieve TEXT buffer line %lu\n", (u_long)lno);
121 #endif
122 for (tp = sp->tiq.cqh_first;
123 tp->lno != lno; tp = tp->q.cqe_next);
124 if (lenp != NULL)
125 *lenp = tp->len;
126 if (pp != NULL)
127 *pp = tp->lb;
128 return (0);
131 * Adjust the line number for the number of lines used
132 * by the text input buffers.
134 if (lno > l2)
135 lno -= l2 - l1;
138 /* Look-aside into the cache, and see if the line we want is there. */
140 * Line cache will not work if different screens view the same
141 * file with different encodings.
142 * Multiple threads accessing the same cache can be a problem as
143 * well.
144 * So, line cache is (temporarily) disabled.
146 if (lno == sp->c_lno) {
147 #if defined(DEBUG) && 0
148 vtrace(sp, "retrieve cached line %lu\n", (u_long)lno);
149 #endif
150 if (lenp != NULL)
151 *lenp = sp->c_len;
152 if (pp != NULL)
153 *pp = sp->c_lp;
154 return (0);
156 sp->c_lno = OOBLNO;
158 nocache:
159 nlen = 1024;
160 retry:
161 /* data.size contains length in bytes */
162 BINC_GOTO(sp, (char *)sp->c_lp, sp->c_blen, nlen);
164 /* Get the line from the underlying database. */
165 memset(&key, 0, sizeof(key));
166 key.data = &lno;
167 key.size = sizeof(lno);
168 memset(&data, 0, sizeof(data));
169 data.data = sp->c_lp;
170 data.ulen = sp->c_blen;
171 data.flags = DB_DBT_USERMEM;
172 switch (ep->db->get(ep->db, NULL, &key, &data, 0)) {
173 case ENOMEM:
174 nlen = data.size;
175 goto retry;
176 default:
177 goto err2;
178 case DB_NOTFOUND:
179 err1: if (LF_ISSET(DBG_FATAL))
180 err2: db_err(sp, lno);
181 alloc_err:
182 err3: if (lenp != NULL)
183 *lenp = 0;
184 if (pp != NULL)
185 *pp = NULL;
186 return (1);
187 case 0:
191 if (FILE2INT(sp, data.data, data.size, wp, wlen)) {
192 if (!F_ISSET(sp, SC_CONV_ERROR)) {
193 F_SET(sp, SC_CONV_ERROR);
194 msgq(sp, M_ERR, "324|Conversion error on line %d", lno);
196 goto err3;
199 /* Reset the cache. */
200 if (wp != data.data) {
201 BINC_GOTOW(sp, sp->c_lp, sp->c_blen, wlen);
202 MEMCPYW(sp->c_lp, wp, wlen);
204 sp->c_lno = lno;
205 sp->c_len = wlen;
207 #if defined(DEBUG) && 0
208 vtrace(sp, "retrieve DB line %lu\n", (u_long)lno);
209 #endif
210 if (lenp != NULL)
211 *lenp = wlen;
212 if (pp != NULL)
213 *pp = sp->c_lp;
214 return (0);
218 * db_delete --
219 * Delete a line from the file.
221 * PUBLIC: int db_delete __P((SCR *, db_recno_t));
224 db_delete(SCR *sp, db_recno_t lno)
226 DBT key;
227 EXF *ep;
229 #if defined(DEBUG) && 0
230 vtrace(sp, "delete line %lu\n", (u_long)lno);
231 #endif
232 /* Check for no underlying file. */
233 if ((ep = sp->ep) == NULL) {
234 ex_emsg(sp, NULL, EXM_NOFILEYET);
235 return (1);
237 if (ep->l_win && ep->l_win != sp->wp) {
238 ex_emsg(sp, NULL, EXM_LOCKED);
239 return 1;
242 /* Update cache, marks, @ and global commands. */
243 if (line_insdel(sp, LINE_DELETE, lno))
244 return 1;
246 /* Log before change. */
247 log_line(sp, lno, LOG_LINE_DELETE_B);
249 /* Update file. */
250 memset(&key, 0, sizeof(key));
251 key.data = &lno;
252 key.size = sizeof(lno);
253 if ((sp->db_error = ep->db->del(ep->db, NULL, &key, 0)) != 0) {
254 msgq(sp, M_DBERR, "003|unable to delete line %lu",
255 (u_long)lno);
256 return (1);
259 /* File now modified. */
260 if (F_ISSET(ep, F_FIRSTMODIFY))
261 (void)rcv_init(sp);
262 F_SET(ep, F_MODIFIED);
264 /* Log after change. */
265 log_line(sp, lno, LOG_LINE_DELETE_F);
267 /* Update screen. */
268 return (scr_update(sp, lno, LINE_DELETE, 1));
271 /* maybe this could be simpler
273 * DB3 behaves differently from DB1
275 * if lno != 0 just go to lno and put the new line after it
276 * if lno == 0 then if there are any record, put in front of the first
277 * otherwise just append to the end thus creating the first
278 * line
280 static int
281 append(SCR *sp, db_recno_t lno, CHAR_T *p, size_t len, lnop_t op, int update)
283 DBT data, key;
284 DBC *dbcp_put;
285 EXF *ep;
286 char *fp;
287 size_t flen;
288 int rval;
290 /* Check for no underlying file. */
291 if ((ep = sp->ep) == NULL) {
292 ex_emsg(sp, NULL, EXM_NOFILEYET);
293 return (1);
295 if (ep->l_win && ep->l_win != sp->wp) {
296 ex_emsg(sp, NULL, EXM_LOCKED);
297 return 1;
300 /* Log before change. */
301 log_line(sp, lno + 1, LOG_LINE_APPEND_B);
303 /* Update file. */
304 memset(&key, 0, sizeof(key));
305 key.data = &lno;
306 key.size = sizeof(lno);
307 memset(&data, 0, sizeof(data));
309 if ((sp->db_error = ep->db->cursor(ep->db, NULL, &dbcp_put, 0)) != 0)
310 return 1;
312 INT2FILE(sp, p, len, fp, flen);
314 if (lno != 0) {
315 if ((sp->db_error = dbcp_put->c_get(dbcp_put, &key, &data, DB_SET)) != 0)
316 goto err2;
318 data.data = fp;
319 data.size = flen;
320 if ((sp->db_error = dbcp_put->c_put(dbcp_put, &key, &data, DB_AFTER)) != 0) {
321 err2:
322 (void)dbcp_put->c_close(dbcp_put);
323 msgq(sp, M_DBERR,
324 (op == LINE_APPEND)
325 ? "004|unable to append to line %lu"
326 : "005|unable to insert at line %lu",
327 (u_long)lno);
328 return (1);
330 } else {
331 if ((sp->db_error = dbcp_put->c_get(dbcp_put, &key, &data, DB_FIRST)) != 0) {
332 if (sp->db_error != DB_NOTFOUND)
333 goto err2;
335 data.data = fp;
336 data.size = flen;
337 if ((sp->db_error = ep->db->put(ep->db, NULL, &key, &data, DB_APPEND)) != 0) {
338 goto err2;
340 } else {
341 key.data = &lno;
342 key.size = sizeof(lno);
343 data.data = fp;
344 data.size = flen;
345 if ((sp->db_error = dbcp_put->c_put(dbcp_put, &key, &data, DB_BEFORE)) != 0) {
346 goto err2;
351 (void)dbcp_put->c_close(dbcp_put);
353 /* File now dirty. */
354 if (F_ISSET(ep, F_FIRSTMODIFY))
355 (void)rcv_init(sp);
356 F_SET(ep, F_MODIFIED);
358 /* Update cache, marks, @ and global commands. */
359 rval = line_insdel(sp, LINE_INSERT, lno + 1);
361 /* Log after change. */
362 log_line(sp, lno + 1, LOG_LINE_APPEND_F);
365 * Update screen.
367 * comment copied from db_append
368 * XXX
369 * Nasty hack. If multiple lines are input by the user, they aren't
370 * committed until an <ESC> is entered. The problem is the screen was
371 * updated/scrolled as each line was entered. So, when this routine
372 * is called to copy the new lines from the cut buffer into the file,
373 * it has to know not to update the screen again.
375 return (scr_update(sp, lno + 1, LINE_INSERT, update) || rval);
379 * db_append --
380 * Append a line into the file.
382 * PUBLIC: int db_append __P((SCR *, int, db_recno_t, CHAR_T *, size_t));
385 db_append(SCR *sp, int update, db_recno_t lno, CHAR_T *p, size_t len)
387 #if defined(DEBUG) && 0
388 vtrace(sp, "append to %lu: len %u {%.*s}\n", lno, len, MIN(len, 20), p);
389 #endif
391 /* Update file. */
392 return append(sp, lno, p, len, LINE_APPEND, update);
396 * db_insert --
397 * Insert a line into the file.
399 * PUBLIC: int db_insert __P((SCR *, db_recno_t, CHAR_T *, size_t));
402 db_insert(SCR *sp, db_recno_t lno, CHAR_T *p, size_t len)
404 #if defined(DEBUG) && 0
405 vtrace(sp, "insert before %lu: len %lu {%.*s}\n",
406 (u_long)lno, (u_long)len, MIN(len, 20), p);
407 #endif
408 return append(sp, lno - 1, p, len, LINE_INSERT, 1);
412 * db_set --
413 * Store a line in the file.
415 * PUBLIC: int db_set __P((SCR *, db_recno_t, CHAR_T *, size_t));
418 db_set(SCR *sp, db_recno_t lno, CHAR_T *p, size_t len)
420 DBT data, key;
421 EXF *ep;
422 char *fp;
423 size_t flen;
424 int rval;
426 #if defined(DEBUG) && 0
427 vtrace(sp, "replace line %lu: len %lu {%.*s}\n",
428 (u_long)lno, (u_long)len, MIN(len, 20), p);
429 #endif
430 /* Check for no underlying file. */
431 if ((ep = sp->ep) == NULL) {
432 ex_emsg(sp, NULL, EXM_NOFILEYET);
433 return (1);
435 if (ep->l_win && ep->l_win != sp->wp) {
436 ex_emsg(sp, NULL, EXM_LOCKED);
437 return 1;
440 /* Log before change. */
441 log_line(sp, lno, LOG_LINE_RESET_B);
443 INT2FILE(sp, p, len, fp, flen);
445 /* Update file. */
446 memset(&key, 0, sizeof(key));
447 key.data = &lno;
448 key.size = sizeof(lno);
449 memset(&data, 0, sizeof(data));
450 data.data = fp;
451 data.size = flen;
452 if ((sp->db_error = ep->db->put(ep->db, NULL, &key, &data, 0)) != 0) {
453 msgq(sp, M_DBERR, "006|unable to store line %lu", (u_long)lno);
454 return (1);
457 /* File now dirty. */
458 if (F_ISSET(ep, F_FIRSTMODIFY))
459 (void)rcv_init(sp);
460 F_SET(ep, F_MODIFIED);
462 /* Update cache, marks, @ and global commands. */
463 rval = line_insdel(sp, LINE_RESET, lno);
465 /* Log after change. */
466 log_line(sp, lno, LOG_LINE_RESET_F);
468 /* Update screen. */
469 return (scr_update(sp, lno, LINE_RESET, 1) || rval);
473 * db_exist --
474 * Return if a line exists.
476 * PUBLIC: int db_exist __P((SCR *, db_recno_t));
479 db_exist(SCR *sp, db_recno_t lno)
481 EXF *ep;
483 /* Check for no underlying file. */
484 if ((ep = sp->ep) == NULL) {
485 ex_emsg(sp, NULL, EXM_NOFILEYET);
486 return (1);
489 if (lno == OOBLNO)
490 return (0);
493 * Check the last-line number cache. Adjust the cached line
494 * number for the lines used by the text input buffers.
496 if (ep->c_nlines != OOBLNO)
497 return (lno <= (F_ISSET(sp, SC_TINPUT) ?
498 ep->c_nlines + (((TEXT *)sp->tiq.cqh_last)->lno -
499 ((TEXT *)sp->tiq.cqh_first)->lno) : ep->c_nlines));
501 /* Go get the line. */
502 return (!db_get(sp, lno, 0, NULL, NULL));
506 * db_last --
507 * Return the number of lines in the file.
509 * PUBLIC: int db_last __P((SCR *, db_recno_t *));
512 db_last(SCR *sp, db_recno_t *lnop)
514 DBT data, key;
515 DBC *dbcp;
516 EXF *ep;
517 db_recno_t lno;
518 CHAR_T *wp;
519 size_t wlen;
521 /* Check for no underlying file. */
522 if ((ep = sp->ep) == NULL) {
523 ex_emsg(sp, NULL, EXM_NOFILEYET);
524 return (1);
528 * Check the last-line number cache. Adjust the cached line
529 * number for the lines used by the text input buffers.
531 if (ep->c_nlines != OOBLNO) {
532 *lnop = ep->c_nlines;
533 if (F_ISSET(sp, SC_TINPUT))
534 *lnop += ((TEXT *)sp->tiq.cqh_last)->lno -
535 ((TEXT *)sp->tiq.cqh_first)->lno;
536 return (0);
539 memset(&key, 0, sizeof(key));
540 key.data = &lno;
541 key.size = sizeof(lno);
542 memset(&data, 0, sizeof(data));
544 if ((sp->db_error = ep->db->cursor(ep->db, NULL, &dbcp, 0)) != 0)
545 goto err1;
546 switch (sp->db_error = dbcp->c_get(dbcp, &key, &data, DB_LAST)) {
547 case DB_NOTFOUND:
548 *lnop = 0;
549 return (0);
550 default:
551 (void)dbcp->c_close(dbcp);
552 alloc_err:
553 err1:
554 msgq(sp, M_DBERR, "007|unable to get last line");
555 *lnop = 0;
556 return (1);
557 case 0:
561 memcpy(&lno, key.data, sizeof(lno));
563 if (lno != sp->c_lno) {
564 FILE2INT(sp, data.data, data.size, wp, wlen);
566 /* Fill the cache. */
567 BINC_GOTOW(sp, sp->c_lp, sp->c_blen, wlen);
568 MEMCPYW(sp->c_lp, wp, wlen);
569 sp->c_lno = lno;
570 sp->c_len = wlen;
572 ep->c_nlines = lno;
574 (void)dbcp->c_close(dbcp);
576 /* Return the value. */
577 *lnop = (F_ISSET(sp, SC_TINPUT) &&
578 ((TEXT *)sp->tiq.cqh_last)->lno > lno ?
579 ((TEXT *)sp->tiq.cqh_last)->lno : lno);
580 return (0);
584 * db_err --
585 * Report a line error.
587 * PUBLIC: void db_err __P((SCR *, db_recno_t));
589 void
590 db_err(SCR *sp, db_recno_t lno)
592 msgq(sp, M_ERR,
593 "008|Error: unable to retrieve line %lu", (u_long)lno);
597 * scr_update --
598 * Update all of the screens that are backed by the file that
599 * just changed.
601 * PUBLIC: int scr_update __P((SCR *sp, db_recno_t lno,
602 * PUBLIC: lnop_t op, int current));
605 scr_update(SCR *sp, db_recno_t lno, lnop_t op, int current)
607 EXF *ep;
608 SCR *tsp;
609 WIN *wp;
611 if (F_ISSET(sp, SC_EX))
612 return (0);
614 /* XXXX goes outside of window */
615 ep = sp->ep;
616 if (ep->refcnt != 1)
617 for (wp = sp->gp->dq.cqh_first; wp != (void *)&sp->gp->dq;
618 wp = wp->q.cqe_next)
619 for (tsp = wp->scrq.cqh_first;
620 tsp != (void *)&wp->scrq; tsp = tsp->q.cqe_next)
621 if (sp != tsp && tsp->ep == ep)
622 if (vs_change(tsp, lno, op))
623 return (1);
624 return (current ? vs_change(sp, lno, op) : 0);
628 * PUBLIC: int line_insdel __P((SCR *sp, lnop_t op, db_recno_t lno));
631 line_insdel(SCR *sp, lnop_t op, db_recno_t lno)
633 int rval;
634 SCR* scrp;
635 EXF *ep;
637 ep = sp->ep;
639 /* Flush the cache, update line count, before screen update. */
640 /* The flushing is probably not needed, since it was incorrect
641 * for db_insert. It might be better to adjust it, like
642 * marks, @ and global
644 for (scrp = ep->scrq.cqh_first; scrp != (void *)&ep->scrq;
645 scrp = scrp->eq.cqe_next)
646 switch (op) {
647 case LINE_INSERT:
648 case LINE_DELETE:
649 if (lno <= scrp->c_lno)
650 scrp->c_lno = OOBLNO;
651 break;
652 case LINE_RESET:
653 if (lno == scrp->c_lno)
654 scrp->c_lno = OOBLNO;
655 break;
658 if (ep->c_nlines != OOBLNO)
659 switch (op) {
660 case LINE_INSERT:
661 ++ep->c_nlines;
662 break;
663 case LINE_DELETE:
664 --ep->c_nlines;
665 break;
668 /* Update marks, @ and global commands. */
669 rval = 0;
670 if (mark_insdel(sp, op, lno))
671 rval = 1;
672 if (ex_g_insdel(sp, op, lno))
673 rval = 1;
675 return rval;