doches / progressbar Goto Github PK

An easy-to-use C library for displaying text progress bars.

License: BSD 3-Clause "New" or "Revised" License

Makefile 5.56% C 62.83% CMake 4.65% C++ 26.96%

progressbar's Introduction

What is this thing?

progressbar is a C-class (it's a convention, dammit) for displaying attractive progress bars on the command line. It's heavily influenced by the ruby ProgressBar gem, whose api and behaviour it imitates.

Ok, what the hell is a C-class, and how do I use one?

progressbar is implemented in pure C99, but using a vaguely object-oriented convention.

Example usage:

progressbar *progress = progressbar_new("Loading",100);
for(int i=0; i < 100; i++)
{
  // Do some stuff
  progressbar_inc(progress);
}
progressbar_finish(progress);

Example output (from progressbar_demo.c):

Additional examples can be found in test/progressbar_demo.c

Why did you do this?

One of the things I miss most when I'm writing C instead of Ruby is the how ridiculously easy it is to write user-friendly, informative CLI apps in Ruby. A big part of that, at least for me, is the ProgressBar gem -- and since most of the time when I'm writing C I'm doing so because I need a tool to handle some long-running, processor-intensive task, I'd really like to have a way of seeing at a glance how much time is remaining and how far along we've gotten. Enter progressbar!

Can I use it?

Of course, if you're so inclined. progressbar is licensed under a simplified BSD license, so feel free to take it and run with it. Details can be found in the LICENSE file.

Why doesn't it compile?

If progressbar fails to build because termcap.h isn't found, you're probably missing the ncurses dev libraries.

gcc -c -std=c99 -Iinclude lib/progressbar.c
lib/progressbar.c:13:45: fatal error: termcap.h: No such file or directory
compilation terminated.

progressbar's People

Contributors

Stargazers

Watchers

progressbar's Issues

progressbar_demo.c not in pure c99, should be built with -std=gnu99

as the title, but I think this is not really important, though.

test/progressbar_demo.c: In function ‘main’:
test/progressbar_demo.c:49:9: warning: implicit declaration of function ‘usleep’ [-Wimplicit-function-declaration]
usleep(SLEEP_US);
^

Working with XCode's debug console

Is there a smart way to integrate this ( fanstatic ) library to work with the XCode debug window?

I can get xCode to open Terminal and the Progressbar works as expected. But if you use the Native xCode debug window it prints a non-beautiful progressbar..

Why stderr instead of stdout?

Thanks you guys for your progressbar, I have used it for a school's project where I have to implement a genetic algorithm for solving QAP (Quadratic Assigment Problem), but I have found in the code that you use "stderr" instead of "stdout," why is it?

The progressbar works (I have not tried userbar) because by default stderr = stdout. I mean, if I run my application and redirect the error output to some log file (as many Lignux (GNU/Linux) applications do - usually /var/log/ directory), the progressbar will not be displayed in the terminal. I think that it will be better to change "stderr" by "stdout."

Thanks.

Undefined symbols for architecture x86_64 Error

I'm getting the below error when compiling in my project when statically linking with the progressbar lib:

Undefined symbols for architecture x86_64:
  "_tgetent", referenced from:
      _get_screen_width in libprogressbar.a(progressbar.o)
  "_tgetnum", referenced from:
      _get_screen_width in libprogressbar.a(progressbar.o)
ld: symbol(s) not found for architecture x86_64
clang: error: linker command failed with exit code 1 (use -v to see invocation)
make: *** [bin] Error 1

I'm on a 2019 macbook running Catalina 10.15.6.
I Tried to use the -m64 arg when building my code with the progressbar lib but havent yet tried this flag when building the progressbar project directly.

Lower minimum cmake version

Per @Mitmischer's suggestion, we ought to lower the minimum required CMake version to something less restrictive than 3.7.

Suggestion: show how it looks like.

I just uploaded this thing at https://asciinema.org/a/8vvbdlvp7pj3557o6q5mv7wsk which you could embed here using [![asciicast](https://asciinema.org/a/8vvbdlvp7pj3557o6q5mv7wsk.png)](https://asciinema.org/a/8vvbdlvp7pj3557o6q5mv7wsk).