aboutsummaryrefslogtreecommitdiffhomepage
path: root/test/README
diff options
context:
space:
mode:
Diffstat (limited to 'test/README')
-rw-r--r--test/README31
1 files changed, 31 insertions, 0 deletions
diff --git a/test/README b/test/README
new file mode 100644
index 000000000..647875251
--- /dev/null
+++ b/test/README
@@ -0,0 +1,31 @@
+The test directory contains some unit and performance tests for Scintilla.
+
+The tests can only be run on Windows using Python 3.x. Running on another platform
+would require writing a file similar to XiteWin.py for that platform. Python 3.x is required
+because its default string type is Unicode and earlier Python versions use byte strings
+and the interface to the platform assumes a particular string type.
+
+A test application is in xite.py and this can be run to experiment:
+pythonw xite.py
+
+To run the basic tests:
+pythonw simpleTests.py
+
+There are some lexing tests with simple input files in several languages in the examples
+subdirectory and their expected lexed states in *.styled where the start of each style
+is marked with {styleNumber}, for example:
+{15}<%@{16}language=javas{15}%>{0}
+
+To run the lexing tests:
+pythonw lexTests.py
+
+To check for performance regressions:
+pythonw performanceTests.py
+While each test run will be different and the timer has only limited granularity, some results
+from a 2 GHz Athlon with a DEBUG build are:
+ 0.187 testAddLine
+. 0.203 testAddLineMiddle
+. 0.171 testHuge
+. 0.203 testHugeInserts
+. 0.312 testHugeReplace
+.