Our configuration
[pylucene.git] / Makefile
1
2 # Makefile for building PyLucene
3 #
4 # Supported operating systems: Mac OS X, Linux and Windows.
5 # See INSTALL file for requirements.
6 # See jcc/INSTALL for information about --shared.
7
8 # Steps to build
9 #   1. Edit the sections below as documented
10 #   2. Edit the JARS variable to add optional contrib modules not defaulted
11 #   3. make
12 #   4. make install
13 #
14 # The install target installs the lucene python extension in python's
15 # site-packages directory.
16 #
17
18 VERSION=3.5.0-3
19 LUCENE_SVN_VER=HEAD
20 LUCENE_VER=3.5.0
21 LUCENE_SVN=http://svn.apache.org/repos/asf/lucene/dev/tags/lucene_solr_3_5_0
22 PYLUCENE:=$(shell pwd)
23 LUCENE_SRC=lucene-java-$(LUCENE_VER)
24 LUCENE=$(LUCENE_SRC)/lucene
25
26
27 # You need to uncomment and edit the variables below in the section
28 # corresponding to your operating system.
29 #
30 # Windows drive-absolute paths need to be expressed cygwin style.
31 #
32 # PREFIX: where programs are normally installed on your system (Unix).
33 # PREFIX_PYTHON: where your version of python is installed.
34 # JCC: how jcc is invoked, depending on the python version:
35 #  - python 2.7:
36 #      $(PYTHON) -m jcc
37 #  - python 2.6:
38 #      $(PYTHON) -m jcc.__main__
39 #  - python 2.5:
40 #      $(PYTHON) -m jcc
41 #  - python 2.4:
42 #      $(PYTHON) $(PREFIX_PYTHON)/lib/python2.4/site-packages/jcc/__main__.py
43 # NUM_FILES is the number of wrapper files to generate. By default, jcc
44 # generates all C++ classes into one single file. This may exceed a compiler
45 # limit.
46 #
47
48 # Mac OS X 10.6 (64-bit Python 2.6, Java 1.6)
49 #PREFIX_PYTHON=/usr
50 #ANT=ant
51 #PYTHON=$(PREFIX_PYTHON)/bin/python
52 #JCC=$(PYTHON) -m jcc.__main__ --shared --arch x86_64
53 #NUM_FILES=4
54
55 # Mac OS X 10.6 (MacPorts 1.8.0 64-bit Python 2.7, Java 1.6)
56 #PREFIX_PYTHON=/opt/local
57 #ANT=ant
58 #PYTHON=$(PREFIX_PYTHON)/bin/python
59 #JCC=$(PYTHON) -m jcc --shared --arch x86_64
60 #NUM_FILES=4
61
62 # Mac OS X 10.6 (MacPorts 1.8.0 64-bit Python 2.6, Java 1.6)
63 #PREFIX_PYTHON=/opt/local
64 #ANT=ant
65 #PYTHON=$(PREFIX_PYTHON)/bin/python
66 #JCC=$(PYTHON) -m jcc.__main__ --shared --arch x86_64
67 #NUM_FILES=4
68
69 # Mac OS X 10.6 (64-bit and 32-bit Python 2.6 together, Java 1.6)
70 #PREFIX_PYTHON=/usr
71 #ANT=ant
72 #PYTHON=$(PREFIX_PYTHON)/bin/python
73 #JCC=$(PYTHON) -m jcc.__main__ --shared --arch x86_64 --arch i386
74 #NUM_FILES=4
75
76 # Mac OS X 10.5 (32-bit Python 2.5, Java 1.5)
77 #PREFIX_PYTHON=/usr
78 #ANT=ant
79 #PYTHON=$(PREFIX_PYTHON)/bin/python
80 #JCC=$(PYTHON) -m jcc --shared
81 #NUM_FILES=4
82
83 # Mac OS X  (Python 2.3.5, Java 1.5, setuptools 0.6c7, Intel Mac OS X 10.4)
84 #PREFIX_PYTHON=/usr
85 #ANT=ant
86 #PYTHON=$(PREFIX_PYTHON)/bin/python
87 #JCC=$(PYTHON) /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages/JCC-2.3-py2.3-macosx-10.4-i386.egg/jcc/__init__.py
88 #NUM_FILES=4
89
90 # Mac OS X  (Python 2.3.5, Java 1.5, setuptools 0.6c7, PPC Mac OS X 10.4)
91 #PREFIX_PYTHON=/usr
92 #ANT=ant
93 #PYTHON=$(PREFIX_PYTHON)/bin/python
94 #JCC=$(PYTHON) /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages/JCC-2.3-py2.3-macosx-10.4-ppc.egg/jcc/__init__.py
95 #NUM_FILES=4
96
97 # Linux     (Ubuntu 6.06, Python 2.4, Java 1.5, no setuptools)
98 #PREFIX_PYTHON=/usr
99 #ANT=ant
100 #PYTHON=$(PREFIX_PYTHON)/bin/python
101 #JCC=$(PYTHON) $(PREFIX_PYTHON)/lib/python2.4/site-packages/jcc/__init__.py
102 #NUM_FILES=4
103
104 # Linux     (Ubuntu 8.10 64-bit, Python 2.5.2, OpenJDK 1.6, setuptools 0.6c9)
105 #PREFIX_PYTHON=/usr
106 #ANT=ant
107 #PYTHON=$(PREFIX_PYTHON)/bin/python
108 #JCC=$(PYTHON) -m jcc --shared
109 #NUM_FILES=4
110
111 PREFIX_PYTHON=$(VIRTUAL_ENV)
112 ANT=ant
113 PYTHON=$(PREFIX_PYTHON)/bin/python
114 JCC=$(PYTHON) -m jcc --shared
115 NUM_FILES=3
116
117 # FreeBSD
118 #PREFIX_PYTHON=/usr
119 #ANT=ant
120 #PYTHON=$(PREFIX_PYTHON)/bin/python
121 #JCC=$(PYTHON) -m jcc
122 #NUM_FILES=4
123
124 # Solaris   (Solaris 11, Python 2.4 32-bit, Sun Studio 12, Java 1.6)
125 #PREFIX_PYTHON=/usr
126 #ANT=/usr/local/apache-ant-1.7.0/bin/ant
127 #PYTHON=$(PREFIX_PYTHON)/bin/python
128 #JCC=$(PYTHON) $(PREFIX_PYTHON)/lib/python2.4/site-packages/jcc/__init__.py
129 #NUM_FILES=4
130
131 # Windows   (Win32, Python 2.5.1, Java 1.6, ant 1.7.0)
132 #PREFIX_PYTHON=/cygdrive/o/Python-2.5.2/PCbuild
133 #ANT=JAVA_HOME=o:\\Java\\jdk1.6.0_02 /cygdrive/o/java/apache-ant-1.7.0/bin/ant
134 #PYTHON=$(PREFIX_PYTHON)/python.exe
135 #JCC=$(PYTHON) -m jcc --shared
136 #NUM_FILES=4
137
138 # Windows   (Win32, msys/MinGW, Python 2.6.4, Java 1.6, ant 1.7.1 (WinAnt))
139 #PREFIX_PYTHON=/c/Python26
140 #ANT=JAVA_HOME="c:\\Program Files\\Java\\jdk1.6.0_18" "/c/Program Files/WinAnt/bin/ant"
141 #PYTHON=$(PREFIX_PYTHON)/python.exe
142 #JCC=$(PYTHON) -m jcc.__main__ --shared --compiler mingw32
143 #NUM_FILES=4
144
145 # Windows   (Win32, Python 2.7, Java 1.6, ant 1.8.1, Java not on PATH)
146 #PREFIX_PYTHON=/cygdrive/c/Python27
147 #ANT=JAVA_HOME=c:\\jdk1.6.0_22 /cygdrive/c/java/apache-ant-1.8.1/bin/ant
148 #PYTHON=$(PREFIX_PYTHON)/python.exe
149 #JCC=$(PYTHON) -m jcc --shared --find-jvm-dll
150 #NUM_FILES=4
151
152 JARS=$(LUCENE_JAR)
153
154 # comment/uncomment the desired/undesired optional contrib modules below
155 JARS+=$(ANALYZERS_JAR)          # many language analyzers
156 JARS+=$(MEMORY_JAR)             # single-document memory index
157 JARS+=$(HIGHLIGHTER_JAR)        # needs memory contrib
158 JARS+=$(EXTENSIONS_JAR)         # needs highlighter contrib
159 JARS+=$(QUERIES_JAR)            # regex and other contrib queries
160 JARS+=$(STEMPEL_JAR)
161 #JARS+=$(SMARTCN_JAR)            # smart chinese analyzer
162 #JARS+=$(SPATIAL_JAR)            # spatial lucene
163 JARS+=$(GROUPING_JAR)           # grouping module
164 JARS+=$(JOIN_JAR)               # join module
165 JARS+=$(FACET_JAR)              # facet module
166 JARS+=$(SPELLCHECKER_JAR)       # spellchecker/suggest module
167
168
169 #
170 # No edits required below
171 #
172
173 SVNOP?=export
174
175 ifeq ($(DEBUG),1)
176   DEBUG_OPT=--debug
177 endif
178
179 DEFINES=-DPYLUCENE_VER="\"$(VERSION)\"" -DLUCENE_VER="\"$(LUCENE_VER)\""
180
181 LUCENE_JAR=$(LUCENE)/build/lucene-core-$(LUCENE_VER).jar
182 ANALYZERS_JAR=$(LUCENE)/build/contrib/analyzers/common/lucene-analyzers-$(LUCENE_VER).jar
183 HIGHLIGHTER_JAR=$(LUCENE)/build/contrib/highlighter/lucene-highlighter-$(LUCENE_VER).jar
184 MEMORY_JAR=$(LUCENE)/build/contrib/memory/lucene-memory-$(LUCENE_VER).jar
185 QUERIES_JAR=$(LUCENE)/build/contrib/queries/lucene-queries-$(LUCENE_VER).jar
186 EXTENSIONS_JAR=build/jar/extensions.jar
187 SMARTCN_JAR=$(LUCENE)/build/contrib/analyzers/smartcn/lucene-smartcn-$(LUCENE_VER).jar
188 STEMPEL_JAR=$(LUCENE)/build/contrib/analyzers/stempel/lucene-stempel-$(LUCENE_VER).jar
189 SPATIAL_JAR=$(LUCENE)/build/contrib/spatial/lucene-spatial-$(LUCENE_VER).jar
190 GROUPING_JAR=$(LUCENE)/build/contrib/grouping/lucene-grouping-$(LUCENE_VER).jar
191 JOIN_JAR=$(LUCENE)/build/contrib/join/lucene-join-$(LUCENE_VER).jar
192 FACET_JAR=$(LUCENE)/build/contrib/facet/lucene-facet-$(LUCENE_VER).jar
193 SPELLCHECKER_JAR=$(LUCENE)/build/contrib/spellchecker/lucene-spellchecker-$(LUCENE_VER).jar
194
195 ICUPKG:=$(shell which icupkg)
196
197 .PHONY: generate compile install default all clean realclean \
198         sources test jars distrib
199
200 default: all
201
202 $(LUCENE_SRC):
203         mkdir -p $(LUCENE_SRC)
204         svn $(SVNOP) -r $(LUCENE_SVN_VER) $(LUCENE_SVN)/lucene $(LUCENE_SRC)/lucene
205
206 sources: $(LUCENE_SRC)
207
208 to-orig: sources
209         mkdir -p $(LUCENE)-orig
210         tar -C $(LUCENE) -cf - . | tar -C $(LUCENE)-orig -xvf -
211
212 from-orig: $(LUCENE)-orig
213         mkdir -p $(LUCENE)
214         tar -C $(LUCENE)-orig -cf - . | tar -C $(LUCENE) -xvf -
215
216 lucene:
217         rm -f $(LUCENE_JAR)
218         $(MAKE) $(LUCENE_JAR)
219
220 $(LUCENE_JAR): $(LUCENE)
221         cd $(LUCENE); $(ANT) -Dversion=$(LUCENE_VER)
222
223 $(ANALYZERS_JAR): $(LUCENE_JAR)
224         cd $(LUCENE)/contrib/analyzers/common; $(ANT) -Dversion=$(LUCENE_VER)
225
226 $(MEMORY_JAR): $(LUCENE_JAR)
227         cd $(LUCENE)/contrib/memory; $(ANT) -Dversion=$(LUCENE_VER)
228
229 $(HIGHLIGHTER_JAR): $(LUCENE_JAR)
230         cd $(LUCENE)/contrib/highlighter; $(ANT) -Dversion=$(LUCENE_VER)
231
232 $(QUERIES_JAR): $(LUCENE_JAR)
233         cd $(LUCENE)/contrib/queries; $(ANT) -Dversion=$(LUCENE_VER)
234
235 $(EXTENSIONS_JAR): $(LUCENE_JAR)
236         $(ANT) -f extensions.xml -Dlucene.dir=$(LUCENE)
237
238 $(SMARTCN_JAR): $(LUCENE_JAR)
239         cd $(LUCENE)/contrib/analyzers/smartcn; $(ANT) -Dversion=$(LUCENE_VER)
240
241 $(STEMPEL_JAR): $(LUCENE_JAR)
242         cd $(LUCENE)/contrib/analyzers/stempel; $(ANT) -Dversion=$(LUCENE_VER)
243
244 $(SPATIAL_JAR): $(LUCENE_JAR)
245         cd $(LUCENE)/contrib/spatial; $(ANT) -Dversion=$(LUCENE_VER)
246
247 $(GROUPING_JAR): $(LUCENE_JAR)
248         cd $(LUCENE)/contrib/grouping; $(ANT) -Dversion=$(LUCENE_VER)
249
250 $(JOIN_JAR): $(LUCENE_JAR)
251         cd $(LUCENE)/contrib/join; $(ANT) -Dversion=$(LUCENE_VER)
252
253 $(FACET_JAR): $(LUCENE_JAR)
254         cd $(LUCENE)/contrib/facet; $(ANT) -Dversion=$(LUCENE_VER)
255
256 $(SPELLCHECKER_JAR): $(LUCENE_JAR)
257         cd $(LUCENE)/contrib/spellchecker; $(ANT) -Dversion=$(LUCENE_VER)
258
259 JCCFLAGS?=
260
261 jars: $(JARS)
262
263
264 ifneq ($(ICUPKG),)
265
266 RESOURCES=--resources $(LUCENE)/contrib/icu/src/resources
267 ENDIANNESS:=$(shell $(PYTHON) -c "import struct; print struct.pack('h', 1) == '\000\001' and 'b' or 'l'")
268
269 resources: $(LUCENE)/contrib/icu/src/resources/org/apache/lucene/analysis/icu/utr30.dat
270
271 $(LUCENE)/contrib/icu/src/resources/org/apache/lucene/analysis/icu/utr30.dat: $(LUCENE)/contrib/icu/src/resources/org/apache/lucene/analysis/icu/utr30.nrm
272         rm -f $@
273         cd $(dir $<); $(ICUPKG) --type $(ENDIANNESS) --add $(notdir $<) new $(notdir $@)
274
275 else
276
277 RESOURCES=
278
279 resources:
280         @echo ICU not installed
281
282 endif
283
284 GENERATE=$(JCC) $(foreach jar,$(JARS),--jar $(jar)) \
285            $(JCCFLAGS) \
286            --package java.lang java.lang.System \
287                                java.lang.Runtime \
288            --package java.util java.util.Arrays \
289                                java.util.HashMap \
290                                java.util.HashSet \
291                      java.text.SimpleDateFormat \
292                      java.text.DecimalFormat \
293                      java.text.Collator \
294            --package java.util.regex \
295            --package java.io java.io.StringReader \
296                              java.io.InputStreamReader \
297                              java.io.FileInputStream \
298            --exclude org.apache.lucene.queryParser.Token \
299            --exclude org.apache.lucene.queryParser.TokenMgrError \
300            --exclude org.apache.lucene.queryParser.QueryParserTokenManager \
301            --exclude org.apache.lucene.queryParser.ParseException \
302            --exclude org.apache.lucene.search.regex.JakartaRegexpCapabilities \
303            --exclude org.apache.regexp.RegexpTunnel \
304            --exclude org.apache.lucene.analysis.cn.smart.AnalyzerProfile \
305            --python lucene \
306            --mapping org.apache.lucene.document.Document 'get:(Ljava/lang/String;)Ljava/lang/String;' \
307            --mapping java.util.Properties 'getProperty:(Ljava/lang/String;)Ljava/lang/String;' \
308            --sequence java.util.AbstractList 'size:()I' 'get:(I)Ljava/lang/Object;' \
309            --rename org.apache.lucene.search.highlight.SpanScorer=HighlighterSpanScorer \
310            --version $(LUCENE_VER) \
311            --module python/collections.py \
312            --module python/ICUNormalizer2Filter.py \
313            --module python/ICUFoldingFilter.py \
314            --module python/ICUTransformFilter.py \
315            $(RESOURCES) \
316            --files $(NUM_FILES)
317
318 generate: jars
319         $(GENERATE)
320
321 compile: jars
322         $(GENERATE) --build $(DEBUG_OPT)
323
324 install: jars
325         $(GENERATE) --install $(DEBUG_OPT) $(INSTALL_OPT)
326
327 bdist: jars
328         $(GENERATE) --bdist
329
330 wininst: jars
331         $(GENERATE) --wininst
332
333 all: sources jars resources compile
334         @echo build of $(PYLUCENE_LIB) complete
335
336 clean:
337         if test -f $(LUCENE)/build.xml; then cd $(LUCENE); $(ANT) clean; fi
338         rm -rf $(LUCENE)/build build
339
340 realclean:
341         if test ! -d $(LUCENE)/.svn; then rm -rf $(LUCENE_SRC); else rm -rf $(LUCENE)/build; fi
342         rm -rf build samples/LuceneInAction/index samples/LuceneInAction/indexes
343
344 OS=$(shell uname)
345 BUILD_TEST:=$(PYLUCENE)/build/test
346
347 ifeq ($(findstring CYGWIN,$(OS)),CYGWIN)
348   BUILD_TEST:=`cygpath -aw $(BUILD_TEST)`
349 else
350   ifeq ($(findstring MINGW,$(OS)),MINGW)
351     BUILD_TEST:=`$(PYTHON) -c "import os, sys; print os.path.normpath(sys.argv[1]).replace(chr(92), chr(92)*2)" $(BUILD_TEST)`
352   endif
353 endif
354
355 install-test:
356         mkdir -p $(BUILD_TEST)
357         PYTHONPATH=$(BUILD_TEST) $(GENERATE) --install $(DEBUG_OPT) --install-dir $(BUILD_TEST)
358
359 samples/LuceneInAction/index:
360         cd samples/LuceneInAction; PYTHONPATH=$(BUILD_TEST) $(PYTHON) index.py
361
362 test: install-test samples/LuceneInAction/index
363         find test -name 'test_*.py' | PYTHONPATH=$(BUILD_TEST) xargs -t -n 1 $(PYTHON)
364         ls samples/LuceneInAction/*Test.py | PYTHONPATH=$(BUILD_TEST) xargs -t -n 1 $(PYTHON)
365         PYTHONPATH=$(BUILD_TEST) $(PYTHON) samples/LuceneInAction/AnalyzerDemo.py
366         PYTHONPATH=$(BUILD_TEST) $(PYTHON) samples/LuceneInAction/AnalyzerUtils.py
367         PYTHONPATH=$(BUILD_TEST) $(PYTHON) samples/LuceneInAction/BooksLikeThis.py
368         PYTHONPATH=$(BUILD_TEST) $(PYTHON) samples/LuceneInAction/Explainer.py samples/LuceneInAction/index programming
369         PYTHONPATH=$(BUILD_TEST) $(PYTHON) samples/LuceneInAction/HighlightIt.py
370         PYTHONPATH=$(BUILD_TEST) $(PYTHON) samples/LuceneInAction/SortingExample.py
371         PYTHONPATH=$(BUILD_TEST) $(PYTHON) samples/LuceneInAction/SynonymAnalyzerViewer.py
372
373
374 ARCHIVE=pylucene-$(VERSION)-src.tar.gz
375 SITE=../site/build/site/en
376
377 distrib:
378         mkdir -p distrib
379         svn export . distrib/pylucene-$(VERSION)
380         tar -cf - --exclude build $(LUCENE_SRC) | tar -C distrib/pylucene-$(VERSION) -xvf -
381         mkdir distrib/pylucene-$(VERSION)/doc
382         tar -C $(SITE) -cf - . | tar -C distrib/pylucene-$(VERSION)/doc -xvf -
383         cd distrib; tar -cvzf $(ARCHIVE) pylucene-$(VERSION)
384         cd distrib; gpg2 --armor --output $(ARCHIVE).asc --detach-sig $(ARCHIVE)
385         cd distrib; openssl md5 < $(ARCHIVE) > $(ARCHIVE).md5
386
387 stage:
388         cd distrib; scp -p $(ARCHIVE) $(ARCHIVE).asc $(ARCHIVE).md5 \
389                            people.apache.org:public_html/staging_area
390
391 release:
392         cd distrib; scp -p $(ARCHIVE) $(ARCHIVE).asc $(ARCHIVE).md5 \
393                            people.apache.org:/www/www.apache.org/dist/lucene/pylucene
394
395 print-%:
396         @echo $* = $($*)