Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add std/pkgconfig module #24320

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions lib/std/pkgconfig.nim
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
#
#
# Nim's Runtime (and compile-time) Library
# (c) Copyright 2024 Nim contributors
#
# See the file "copying.txt", included in this
# distribution, for details about the copyright.
#

## This module implements a compile-time procedure for calling ``pkg-config``.
##
## https://www.freedesktop.org/wiki/Software/pkg-config/

from std/envvars import getEnv

proc pkgConfig*(args: string): string {.compiletime.} =
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about cross platform support?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pkg-config doesn't seem to have any flags for cross-compiling.

For cross-compling I would set $PKG_CONFIG_PATH to somewhere with pkg-config files for your target, which can be done by calling the compiler with putenv:PKG_CONFIG_PATH=your-cross-pkg-config-files.

## Call **pkg-config** with ``args``.
## If ``$PKG_CONFIG`` is set in the environment then it will
## be used instead of ``pkg-config`` from ``$PATH``.
##
## ```nim
## import std/pkgconfig
##
## discard pkgConfig" --atleast-version=3 openssl"
## # If the available openssl version is less than 3.0.0
## # then pkg-config returns non-zero and a defect is raised.
##
## {.passC: pkgConfig" --cflags openssl".}
## {.passL: pkgConfig" --libs openssl".}
## # Pass command-line arguments from pkg-config to the compiler.
## ```
var cmd = getEnv("PKG_CONFIG", "pkg-config") & " " & args
var code: int
(result, code) = gorgeEx(cmd)
if code != 0:
var msg = cmd
msg.add "\nPKG_CONFIG="
msg.add getEnv("PKG_CONFIG")
msg.add "\nPKG_CONFIG_PATH="
msg.add getEnv("PKG_CONFIG_PATH")
msg.add '\n'
msg.add result
raise newException(AssertionDefect, msg)