summaryrefslogtreecommitdiff
path: root/biblio/bibtex/utils/pybib/Bibliography.py
blob: e61b66c09ecb94eb401e9ae2b7d45885a62131a5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# Bibliography class
#   - essentially a container for many BibEntry objects
#   - provides methods for reading/writing the bibliography
#   - provides iterators, sorting etc


# Copyright (c) 2007, Peter Corke
#
# All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above copyright
#       notice, this list of conditions and the following disclaimer in the
#       documentation and/or other materials provided with the distribution.
#     * The name of the copyright holder may not be used to endorse or 
#	promote products derived from this software without specific prior 
#	written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
# THE POSSIBILITY OF SUCH DAMAGE.
import string;
import BibEntry;
import urllib;
import urlparse;
import os;
import os.path;
import sys;

NoSuchFile = "No such file";

class Bibliography:

	def __init__(self):
		self.keyList = [];
		self.abbrevDict = {}

	def open(self, filename):
		if filename == '-':
			self.filename = "stdin";
			return sys.stdin;
		urlbits = urlparse.urlparse('~/lib/bib/z.bib');
		if urlbits[0]:
			# path is a URL
			fp = urllib.urlopen(filename);
			self.filename = filename;
		else:
			# path is a local file
			path = os.environ['BIBPATH'];
			for p in string.split(path, os.pathsep):
				f = os.path.join(p, filename);
				if os.path.isfile(f):
					break;
			else:
				raise NoSuchFile;

			fp = open(f, "r");
			home = os.path.expanduser('~');
			f2 = os.path.abspath(f);
			common = os.path.commonprefix([home, f2]);
			if common:
				self.filename = "~" + f2[len(common):]
			else:
				self.filename = f;

			return fp;

	def close(self, fp):
		fp.close();

	# resolve all abbreviations found in the value fields of all entries
	def resolveAbbrev(self):
		#print >> sys.stderr, len(self.abbrevDict);
		for be in self:
			for f in be:
				v = be.getField(f);
				if isinstance(v,str): 
					if v in self.abbrevDict:
						if self.abbrevDict[v]:
							be.setField(f, self.abbrevDict[v]);

	def insertEntry(self, be, ignore=False):
		#print >> sys.stderr, "inserting key ", be.getKey()
		# should check to see if be is of BibEntry type
		key = be.getKey();
		if key in [x.key for x in self.keyList]:
			if not ignore:
				print >> sys.stderr, "key %s already in dictionary" % (key)
			return False;
		self.keyList.append(be);
		return True;

	def insertAbbrev(self, abbrev, value):
		#print >> sys.stderr, "inserting abbrev ", abbrev
		if abbrev in self.abbrevDict:
			#print >> sys.stderr, "abbrev %s already in list" % (abbrev)
			return False;
		self.abbrevDict[abbrev] = value;
		#be.brief();
		return True;

	def __repr__(self):
		print >> sys.stderr

	def brief(self):
		for be in self:
			be.brief();

	def getFilename(self):
		return self.filename;

	def getAbbrevs(self):
		return self.abbrevDict;


	def display(self):
		for be in self:
			be.display();
			print >> sys.stderr

	def __contains__(self, key):
		return key in [x.key for x in self.keyList];

	def __getitem__(self, i):
		if type(i) is str:
			index = [x.key for x in self.keyList].index(i);
			return self.keyList[index];
		elif type(i) is int:
			return self.keyList[i];
		else:
			raise;

	def __len__(self):
		return len(self.keyList);


	def sort(self, sortfunc):
		# turn the dictionary of entries into a list so we can sort it
		self.keyList.sort(sortfunc);


	# return list of all bibentry's that match the search spec
	def search(self, key, str, type="all", caseSens=0):
		if str == '*':
			return self.keyList;
		
		result = [];
		if string.lower(type) == "all":
			for be in self:
				if be.search(key, str, caseSens):
					result.append(be);
		else:
			for be in self:
				if be.isRefType(type) and be.search(key, str, caseSens):
					result.append(be);
		return result;