← Back to branch summary

~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to src/3rdparty/sqlite/vdbe.h

  • Committer: Bazaar Package Importer
  • Author(s): Adam Conrad
  • Date: 2005-08-24 04:09:09 UTC
  • Revision ID: james.westby@ubuntu.com-20050824040909-xmxe9jfr4a0w5671
Tags: upstream-4.0.0
Import upstream version 4.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/3rdparty/sqlite/vdbe.h
 
1
/*
 
2
** 2001 September 15
 
3
**
 
4
** The author disclaims copyright to this source code.  In place of
 
5
** a legal notice, here is a blessing:
 
6
**
 
7
**    May you do good and not evil.
 
8
**    May you find forgiveness for yourself and forgive others.
 
9
**    May you share freely, never taking more than you give.
 
10
**
 
11
*************************************************************************
 
12
** Header file for the Virtual DataBase Engine (VDBE)
 
13
**
 
14
** This header defines the interface to the virtual database engine
 
15
** or VDBE.  The VDBE implements an abstract machine that runs a
 
16
** simple program to access and modify the underlying database.
 
17
**
 
18
** $Id: vdbe.h,v 1.94 2005/03/23 01:48:48 drh Exp $
 
19
*/
 
20
#ifndef _SQLITE_VDBE_H_
 
21
#define _SQLITE_VDBE_H_
 
22
#include <stdio.h>
 
23
 
 
24
/*
 
25
** A single VDBE is an opaque structure named "Vdbe".  Only routines
 
26
** in the source file sqliteVdbe.c are allowed to see the insides
 
27
** of this structure.
 
28
*/
 
29
typedef struct Vdbe Vdbe;
 
30
 
 
31
/*
 
32
** A single instruction of the virtual machine has an opcode
 
33
** and as many as three operands.  The instruction is recorded
 
34
** as an instance of the following structure:
 
35
*/
 
36
struct VdbeOp {
 
37
  u8 opcode;          /* What operation to perform */
 
38
  int p1;             /* First operand */
 
39
  int p2;             /* Second parameter (often the jump destination) */
 
40
  char *p3;           /* Third parameter */
 
41
  int p3type;         /* P3_STATIC, P3_DYNAMIC or P3_POINTER */
 
42
#ifdef VDBE_PROFILE
 
43
  int cnt;            /* Number of times this instruction was executed */
 
44
  long long cycles;   /* Total time spend executing this instruction */
 
45
#endif
 
46
};
 
47
typedef struct VdbeOp VdbeOp;
 
48
 
 
49
/*
 
50
** A smaller version of VdbeOp used for the VdbeAddOpList() function because
 
51
** it takes up less space.
 
52
*/
 
53
struct VdbeOpList {
 
54
  u8 opcode;          /* What operation to perform */
 
55
  signed char p1;     /* First operand */
 
56
  short int p2;       /* Second parameter (often the jump destination) */
 
57
  char *p3;           /* Third parameter */
 
58
};
 
59
typedef struct VdbeOpList VdbeOpList;
 
60
 
 
61
/*
 
62
** Allowed values of VdbeOp.p3type
 
63
*/
 
64
#define P3_NOTUSED    0   /* The P3 parameter is not used */
 
65
#define P3_DYNAMIC  (-1)  /* Pointer to a string obtained from sqliteMalloc() */
 
66
#define P3_STATIC   (-2)  /* Pointer to a static string */
 
67
#define P3_POINTER  (-3)  /* P3 is a pointer to some structure or object */
 
68
#define P3_COLLSEQ  (-4)  /* P3 is a pointer to a CollSeq structure */
 
69
#define P3_FUNCDEF  (-5)  /* P3 is a pointer to a FuncDef structure */
 
70
#define P3_KEYINFO  (-6)  /* P3 is a pointer to a KeyInfo structure */
 
71
#define P3_VDBEFUNC (-7)  /* P3 is a pointer to a VdbeFunc structure */
 
72
#define P3_MEM      (-8)  /* P3 is a pointer to a Mem*    structure */
 
73
 
 
74
/* When adding a P3 argument using P3_KEYINFO, a copy of the KeyInfo structure
 
75
** is made.  That copy is freed when the Vdbe is finalized.  But if the
 
76
** argument is P3_KEYINFO_HANDOFF, the passed in pointer is used.  It still
 
77
** gets freed when the Vdbe is finalized so it still should be obtained
 
78
** from a single sqliteMalloc().  But no copy is made and the calling
 
79
** function should *not* try to free the KeyInfo.
 
80
*/
 
81
#define P3_KEYINFO_HANDOFF (-9)
 
82
 
 
83
/*
 
84
** The following macro converts a relative address in the p2 field
 
85
** of a VdbeOp structure into a negative number so that 
 
86
** sqlite3VdbeAddOpList() knows that the address is relative.  Calling
 
87
** the macro again restores the address.
 
88
*/
 
89
#define ADDR(X)  (-1-(X))
 
90
 
 
91
/*
 
92
** The makefile scans the vdbe.c source file and creates the "opcodes.h"
 
93
** header file that defines a number for each opcode used by the VDBE.
 
94
*/
 
95
#include "opcodes.h"
 
96
 
 
97
/*
 
98
** Prototypes for the VDBE interface.  See comments on the implementation
 
99
** for a description of what each of these routines does.
 
100
*/
 
101
Vdbe *sqlite3VdbeCreate(sqlite3*);
 
102
void sqlite3VdbeCreateCallback(Vdbe*, int*);
 
103
int sqlite3VdbeAddOp(Vdbe*,int,int,int);
 
104
int sqlite3VdbeOp3(Vdbe*,int,int,int,const char *zP3,int);
 
105
int sqlite3VdbeAddOpList(Vdbe*, int nOp, VdbeOpList const *aOp);
 
106
void sqlite3VdbeChangeP1(Vdbe*, int addr, int P1);
 
107
void sqlite3VdbeChangeP2(Vdbe*, int addr, int P2);
 
108
void sqlite3VdbeChangeP3(Vdbe*, int addr, const char *zP1, int N);
 
109
void sqlite3VdbeDequoteP3(Vdbe*, int addr);
 
110
int sqlite3VdbeFindOp(Vdbe*, int, int, int);
 
111
VdbeOp *sqlite3VdbeGetOp(Vdbe*, int);
 
112
int sqlite3VdbeMakeLabel(Vdbe*);
 
113
void sqlite3VdbeDelete(Vdbe*);
 
114
void sqlite3VdbeMakeReady(Vdbe*,int,int,int,int,int);
 
115
int sqlite3VdbeFinalize(Vdbe*);
 
116
void sqlite3VdbeResolveLabel(Vdbe*, int);
 
117
int sqlite3VdbeCurrentAddr(Vdbe*);
 
118
void sqlite3VdbeTrace(Vdbe*,FILE*);
 
119
int sqlite3VdbeReset(Vdbe*);
 
120
int sqliteVdbeSetVariables(Vdbe*,int,const char**);
 
121
void sqlite3VdbeSetNumCols(Vdbe*,int);
 
122
int sqlite3VdbeSetColName(Vdbe*, int, const char *, int);
 
123
void sqlite3VdbeCountChanges(Vdbe*);
 
124
sqlite3 *sqlite3VdbeDb(Vdbe*);
 
125
 
 
126
#ifndef NDEBUG
 
127
  void sqlite3VdbeComment(Vdbe*, const char*, ...);
 
128
# define VdbeComment(X)  sqlite3VdbeComment X
 
129
#else
 
130
# define VdbeComment(X)
 
131
#endif
 
132
 
 
133
#endif