Environmentally Friendly

Continued from here.

The Qt painting system uses four quite interesting environment variables: QT_FLUSH_PAINT, QT_FLUSH_PAINT_EVENT, QT_FLUSH_UPDATE and QT_FLUSH_WINDOWSURFACE. The purpose of each of these four is to initialize painting surfaces with a yellow colour before painting. See Aaron's blog on this for an example.

The input method module, qmultiinputcontext.cpp, uses the QT_IM_MODULE and QT4_IM_MODULE variables to pick an appropriate module.


If you have a debug version of Qt, QT_LAYOUT_DEBUG adds additional warning messages indicating if you place your widgets in strange layouts (wrong parent or layout).

If you want to skip Qt's double buffering (the backing store) you can use the QT_ONSCREEN_PAINT variable to force all the painting to be made directly to the screen.

The QT_PLUGIN_PATH environment variable can be used to control where Qt looks for plugins.

Using the QT_STYLE_NO_PIXMAPCACHE
environment variable, you can make the Plastique style not use the QPixmapCache.

The WebKit module listens to the QT_WEBKIT_LOG and QTWEBKIT_PLUGIN_PATH variables. These two control which logging channels to use and where to look for plugins.

This concludes this afternoons grepping. I will continue with TMPDIR before reaching the Qt for Embedded Linux source.

Interesting

This is an interesting read - good thing I didn't show my script that extracts the lines and files where each variable is used :-). I learned a thing or two, so thanks!

It is all about the environment

I've just downloaded Qt 4.5 beta 1 and started playing with it. One thing that I've run into a couple of times now are environment variables. Their usage is quite sparsely documented, and can really prove to be useful. So, to have an excuse to look around in the source, I greped a bit.

grep getenv -r src/ | grep cpp\: | grep -o "\"[A-Z_0-9]*\"" | sed 's/"//g'

The X11 version gives 83 hits, while Qt for Embedded Linux (tp1) gives 101. Mergin the two gives 108 unique strings. The difference between these two is fun to look at, but lets start with the more commonly used version: X11.

The variables BROWSER and DEFAULT_BROWSER are used from the QDesktopServices class. The XDG_CACHE_HOME, XDG_CONFIG_HOME and XDG_DATA_HOME are also used by the same class. These variables are all specified in the XDG Base Directory Specification from freedesktop.

QApplication uses a number of environment variables. First, a whole range of variables regarding sessions and desktop ids: DESKTOP_SESSION, DESKTOP_STARTUP_ID, GNOME_DESKTOP_SESSION_ID and SESSION_MANAGER. Then, there is the KDEHOME directory.

There are a number of tuning variables that affect the QApplication class. I have not over analyzed the following, so correct my explanations if I'm wrong.

• QT_NO_GLIB - prevents Qt from using GLib's event loop.
• QT_SLOW_TOPLEVEL_RESIZE - used to solve KDE bug #157659.
• QT_USE_NATIVE_WINDOWS - makes Qt flicker :-)
• QT_X11_NO_FONTCONFIG - makes Qt not to use X11's FontConfig.
• QT_X11_NO_MITSHM - stops Qt form using the MIT-SHM X11 extension.
• QT_X11_NO_XRENDER - prevents Qt from using the Xrender extension.

The QSslSocket class uses DYLD_LIBRARY_PATH and LD_LIBRARY_PATH through qsslsocket_openssl_symbols.cpp.

GTK2_RC_FILES is used to find GTK symbols when styling. KDEDIRS and KDE_SESSION_VERSION are also used by the style classes.

HOME is used from the classes QFSFileEngine and QPrintDialog.

Phonon uses a whole bunch of environment variables. I will not dive deeper into these, at least not for now.

• PHONON_DEBUG
• PHONON_GST_ALL_EFFECTS
• PHONON_GST_AUDIOSINK
• PHONON_GST_DEBUG
• PHONON_GST_FPS
• PHONON_GST_VIDEOMODE
• PHONON_PLATFORMPLUGIN
• KDE_FULL_SESSION
• GNOME_DESKTOP_SESSION_ID

The LANG variable is used by QLocale as expected, but also by QTextCodec and QIconvCodec. The variables prefixed with LC_ are also used by the same classes.

• LC_ALL (QLocale, QIconvCodec, QTextCodec)
• LC_CTYPE (QIconvCodec, QTextCodec)
• LC_MEASUREMENT (QLocale)
• LC_NUMERIC (QLocale)

The Qt 3 support version of QFileDialog uses LOGNAME when trying to determine the location of ~.

LPDEST is used by QPdf and QPrinterInfo. The same classes also use the NGPRINTER, NPRINTER and PRINTER variables.

MALLOCSTATS is ued by the webkit JavaScriptCore component. Continuing in the webkit sources, the WebCore component uses MOZILLA_HOME, MOZ_PLUGIN_PATH, QT_WEBKIT_LOG and QTWEBKIT_PLUGIN_PATH.

One of the most popular environment variables, PATH, is used by FreeType, libtiff, QProcess, QCoreApplication as well as Q3Process.

QDBUS_DEBUG can be used to turn on d-bus debugging.

The QT4_IM_MODULE variable controls the input method to use.

QT_ACCESSIBILITY makes it possible to turn of accessibility (just set it to a non-one value).

By setting QT_CRASH_OUTPUT to a file name, a backtrace is written there when a signal is encountered.

Set QT_DEBUG_PLUGINS to a non-zero value to enable debugging of Qt plug-ins.

The QTestLib module uses a number of variables:

• QTEST_COLORED - controlls if the output should be coloured or not.
• QTEST_EVENT_DELAY - delays events.
• QTEST_KEYEVENT_DELAY - delays key events.
• QTEST_KEYEVENT_VERBOSE - verbose output for keyboard events.
• QTEST_MOUSEEVENT_DELAY - delays mouse events.

To make Qt exit on warnings, set QT_FATAL_WARNINGS.

Now I'm about half-way through my list and, as all of you knows, time flies when you're having fun. Next time, I'll resume at QT_FLUSH_PAINT!