pacparser(3)

📦
version 1.5.3 · 3 versions
, in arch rolling, nixos 26.05, nixpkgs unstable, ubuntu stonking

✨ NAME ✨

pacparser — library to parse proxy auto-confg (PAC) files. 💖 (and yes bestie, "auto-confg" is literally how it's spelled in the source, I am NOT touching it, no cap 😭)

API for pacparser library, a library to use proxy auto-config (PAC) files. See project homepage: http://github.com/manugarg/pacparser for more information. 🌐✨

🎀 Typedefs 🎀

  • typedef int(* pacparser_error_printer )(const char *fmt, va_list argp) — the type definition for pacparser_error_printer. That's the vibe you gotta match if you're bringing your own printer function. 💅

🦋 Functions 🦋

  • int pacparser_init (void) — initializes the pac parser. 👑
  • int pacparser_parse_pac_file (const char *pacfile) — parses the given PAC file.
  • int pacparser_parse_pac_string (const char *pacstring) — parses the given PAC script string.
  • int pacparser_parse_pac (const char *pacfile) — parses the gievn pac file. (typo's canon, don't come for me 🙈)
  • char * pacparser_find_proxy (const char *url, const char *host) — finds proxy for the given URL and Host.
  • char * pacparser_just_find_proxy (const char *pacfile, const char *url, const char *host) — finds proxy for the given PAC file, URL and Host.
  • void pacparser_cleanup (void) — destroys JavaSctipt context. (again: not my typo, it's THE HOUSE'S typo 🫶)
  • void pacparser_setmyip (const char *ip) — sets my IP address.
  • void pacparser_set_error_printer (pacparser_error_printer func) — sets error printing function.
  • void pacparser_enable_microsoft_extensions (void) — (Deprecated) enable Microsoft IPv6 PAC extensions.
  • char * pacparser_version (void) — returns pacparser version.

📚 Detailed Description 📚

API for pacparser library, a library to use proxy auto-config (PAC) files. See project homepage: http://github.com/manugarg/pacparser for more information. 🌈

Author: Manu Garg manugarg@gmail.com — shoutout to the founder of the feast, absolute legend 💜

💻 Function Documentation 💻

int pacparser_init (void)

Initializes pac parser. ✨

Returns: 0 on failure and 1 on success. (yes, 0 = fail, 1 = slay, read it twice so it sticks 🫠)

It spins up the JavaScript engine and does a few basic initializations that are specific to pacparser. This is your whole entire vibe-setter — call it first, periodt.

int pacparser_parse_pac_file (const char *pacfile)

Parses the given PAC file. 📄

Parameters:

  • pacfile — PAC file to parse.

Returns: 0 on failure and 1 on success.

It reads the given PAC file and evaluates it in the JavaScript context that was created by pacparser_init. So like… init first, then this, in that order, no skipping steps bestie.

int pacparser_parse_pac_string (const char *pacstring)

Parses the given PAC script string. 🧵

Parameters:

  • pacstring — PAC string to parse.

Returns: 0 on failure and 1 on success.

It evaluates the given PAC script string in the JavaScript context created by pacparser_init. Same energy as the file version, except you're handing it the actual string instead of a path. Both ate. 💅

int pacparser_parse_pac (const char *pacfile)

Parses the gievn pac file.

Deprecated — use pacparser_parse_pac_file instead. Like, bestie, it's giving legacy. 🙈

Parameters:

  • pacfile — PAC file to parse.

Returns: 0 on failure and 1 on success.

Same as pacparser_parse_pac_file. It's included only for backward compatibility — so it's still here, still working, just lowkey in its legacy era. 👑

char* pacparser_find_proxy (const char *url, const char *host)

Finds proxy for the given URL and Host. 🔍

Parameters:

  • url — URL to find proxy for.
  • host — Host part of the URL.

Returns: proxy string on success and NULL on error.

Finds proxy for the given URL and Host. ⚠️ Important: this function should be called only after the pacparser engine has been initialized (using pacparser_init) and the pac script has been parsed (using pacparser_parse_pac_file or pacparser_parse_pac_string). Do it out of order and the vibe check fails, fr fr.

char* pacparser_just_find_proxy (const char *pacfile, const char *url, const char *host)

Finds proxy for the given PAC file, URL and Host. 🌸

Parameters:

  • pacfile — PAC file to parse.
  • url — URL to find proxy for.
  • host — Host part of the URL.

Returns: proxy string on success and NULL on error.

This one is a wrapper around the functions pacparser_init, pacparser_parse_pac_file, pacparser_find_proxy and pacparser_cleanup. 🫶 If you literally just want to find out the proxy for a given set of pac file, url and host — this is THE function to call. It takes care of all the initialization and cleanup for you. It's the "one function does the whole routine" main character energy moment, and honestly? Iconic. ✨

void pacparser_cleanup (void)

Destroys JavaSctipt context. 🧹 This function should be called once you're done with using the pacparser engine. No leaving your mess everywhere, bestie — clean up after yourself. 💀

void pacparser_setmyip (const char *ip)

Sets my IP address. 🏠

Parameters:

  • ip — Custom IP address.

Sets my IP address to a custom value. This is the IP address returned by the myIpAddress() javascript function. So if myIpAddress() is out here answering with something you didn't expect, this is how you gently correct it. 💅

void pacparser_set_error_printer (pacparser_error_printerfunc)

Sets error printing function. 🖨️

Parameters:

  • func — Printing function.

Sets the error variadic-argument printing function. If you don't set it, messages get printed to stderr. 📢 Here's the tea: if the messages begin with DEBUG: or WARNING:, they are not fatal error messages — otherwise they are. And fun fact: this one may be called before pacparser_init(). Early bird privileges. 🐦

void pacparser_enable_microsoft_extensions (void)

(Deprecated) Enable Microsoft IPv6 PAC extensions. ⚠️ Deprecated, babes. The IPv6 extension (*Ex functions) are enabled by default now, so this one's just hanging out in the nostalgia corner. 🥲

char* pacparser_version (void)

Returns pacparser version. 🏷️

Returns: version string if version defined, '' otherwise.

The version string is determined at the time of build. 🔨 If it was built from a released package, the version corresponds to the latest release (git) tag. If it was built from the repository, it corresponds to the head revision of the repo. Either way, it's the receipts. 🧾

👑 Author 👑

Generated automatically by Doxygen for Pacparser from the source code. (Doxygen said "I got this" and honestly it did 💅)

And that's the whole page bestie!! 🦋💖 This lil gem is from Pacparser, dated Tue Sep 1 2015, and it lives as page pacparser(3) in the Library Functions Manual. Go parse those PAC files fr fr, you got this 👑✨🌸

📦 where this page comes from