1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
|
/*********************************************************************
Extensions to GNU Make for working with FITS files.
This is part of GNU Astronomy Utilities (Gnuastro) package.
------------------------------------------------------------------------
DO NOT USE 'error()': this library is not called by Gnuastro, but by
'make', which can have linked to its own separate 'error' implementation.
------------------------------------------------------------------------
Original author:
Mohammad Akhlaghi <mohammad@akhlaghi.org>
Contributing author(s):
Copyright (C) 2022-2024 Free Software Foundation, Inc.
Gnuastro is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.
Gnuastro is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with Gnuastro. If not, see <http://www.gnu.org/licenses/>.
**********************************************************************/
#include <config.h>
#include <stdio.h>
#include <errno.h>
#include <error.h>
#include <string.h>
#include <stdlib.h>
#include <gnumake.h>
#include <gnuastro/txt.h>
#include <gnuastro/pointer.h>
#include <gnuastro-internal/options.h>
#include <gnuastro-internal/checkset.h>
/* Necessary for GNU Make. */
int plugin_is_GPL_compatible=1;
/* Names of the separate functions. */
#define MAKEPLUGIN_FUNC_PREFIX "ast"
/* Basic text functions */
static char *text_prev=MAKEPLUGIN_FUNC_PREFIX"-text-prev";
static char *text_to_upper=MAKEPLUGIN_FUNC_PREFIX"-text-to-upper";
static char *text_to_lower=MAKEPLUGIN_FUNC_PREFIX"-text-to-lower";
static char *text_prev_batch=MAKEPLUGIN_FUNC_PREFIX"-text-prev-batch";
static char *text_prev_batch_by_ram=MAKEPLUGIN_FUNC_PREFIX"-text-prev-batch-by-ram";
static char *text_contains_name=MAKEPLUGIN_FUNC_PREFIX"-text-contains";
static char *text_not_contains_name=MAKEPLUGIN_FUNC_PREFIX"-text-not-contains";
/* Gnuastro analysis functions */
static char *version_is_name=MAKEPLUGIN_FUNC_PREFIX"-version-is";
static char *fits_with_keyvalue_name=MAKEPLUGIN_FUNC_PREFIX"-fits-with-keyvalue";
static char *fits_unique_keyvalues_name=MAKEPLUGIN_FUNC_PREFIX"-fits-unique-keyvalues";
/**********************************************************************/
/*************** Internal functions ***************/
/**********************************************************************/
/* Return 1 if there is a problem. */
static int
makeplugin_sanity_check(char **argv, size_t num)
{
char *c;
size_t i;
/* In case any of the arguments are an empty string (only containing the
C locale space characters identified with 'isspace'), then just return
an empty string. */
for(i=0;i<num;++i)
{
for(c=argv[i]; c!=NULL && *c!='\0'; ++c) if(!isspace(*c)) break;
if(*c=='\0') return 1; /* When the string is only "space". */
}
/* All checks passed, everything is good. */
return 0;
}
/**********************************************************************/
/*************** Configuration function ***************/
/**********************************************************************/
static char *
makeplugin_version_is(const char *caller, unsigned int argc, char **argv)
{
int check=0;
char *version, *out=NULL;
/* Sanity check. */
if(makeplugin_sanity_check(argv, 1)) return NULL;
/* If the version matches, set the value of 'check'. */
version=gal_txt_trim_space(argv[0]);
if( !strcmp(PACKAGE_VERSION, version) ) check=1;
/* Write the value into the 'out' pointer. */
if( asprintf(&out, "%d", check)<0 )
{
fprintf(stderr, "ast-version-is: %s: couldn't allocate "
"output string", __func__);
exit(1);
}
/* Return the output string. */
return out;
}
/**********************************************************************/
/*************** Text functions ***************/
/**********************************************************************/
/* Base function that is used for both the contains and not-contains
functions. */
static char *
makeplugin_text_contains_base(char **argv, int has1_not0)
{
char *out=NULL;
gal_list_str_t *tmp, *strings, *outlist=NULL;
char *match=argv[0]; /* No trimming the white space before/after, as in */
/* Sanity check. */
if(makeplugin_sanity_check(argv, 2)) return NULL;
/* Parse the input strings and find the ones that match. */
strings=gal_list_str_extract(argv[1]);
for(tmp=strings; tmp!=NULL; tmp=tmp->next)
if( gal_txt_contains_string(tmp->v, match)==has1_not0 )
gal_list_str_add(&outlist, tmp->v, 0);
/* Write the list into one string, but first reverse it so it has the
same order as the input. */
gal_list_str_reverse(&outlist);
out=gal_list_str_cat(outlist, ' ');
/* Clean up and return. */
gal_list_str_free(strings, 1);
gal_list_str_free(outlist, 0); /* We didn't allocate these. */
return out;
}
/* Return any of the input strings that contain the given string. It takes
two arguments:
0. String to check.
1. List of text. */
static char *
makeplugin_text_contains(const char *caller, unsigned int argc,
char **argv)
{
return makeplugin_text_contains_base(argv, 1);
}
/* Return any of the input strings that contain the given string. It takes
two arguments:
0. String to check.
1. List of text. */
static char *
makeplugin_text_not_contains(const char *caller, unsigned int argc,
char **argv)
{
return makeplugin_text_contains_base(argv, 0);
}
/* Convert input string to upper-case. */
static char *
makeplugin_text_to_upper(const char *caller, unsigned int argc,
char **argv)
{
char *out;
/* Sanity check. */
if(makeplugin_sanity_check(argv, 1)) return NULL;
/* Main operation. */
gal_checkset_allocate_copy(argv[0], &out);
gal_checkset_string_case_change(out, 1);
return out;
}
/* Convert input string to upper-case. */
static char *
makeplugin_text_to_lower(const char *caller, unsigned int argc,
char **argv)
{
char *out;
/* Sanity check. */
if(makeplugin_sanity_check(argv, 1)) return NULL;
/* Main operation. */
gal_checkset_allocate_copy(argv[0], &out);
gal_checkset_string_case_change(out, 0);
return out;
}
/* Given one of the words of the input list, this function will return a
string containing the previous batch of words. */
static char *
makeplugin_text_prev_batch_work(char *target, size_t num_in_batch,
char *list)
{
size_t anum=0, starti, endi, outlen;
int is_first_batch=1, target_found=0;
char *startend[4]={NULL, NULL, NULL, NULL};
char *cp, *token, *saveptr=NULL, *out=NULL, *delimiters=" ";
/* Small sanity check. */
if(num_in_batch==0)
{
fprintf(stderr, "%s: a bug! Please contact us at '%s' to "
"find and fix the problem. The value to 'num_in_batch' is 0",
__func__, PACKAGE_BUGREPORT);
exit(1);
}
/* Parse the line to find the desired element, but first copy the input
list into a new editable space with 'strdupa'. */
gal_checkset_allocate_copy(list, &cp);
token=strtok_r(cp, delimiters, &saveptr);
do
{
/* For the first num_in_batch elements, we don't should not set the
first two pointers of 'startend'. Startend contains the following
four pointers:
startend[0] --> FIRST token in PREVIOUS batch.
startend[1] --> LAST token in PREVIOUS batch.
startend[2] --> FIRST token in THIS batch.
startend[3] --> LAST token in THIS batch.
First, let's check if we at the start of a batch: if so, all the
elements of 'startend' need to be reset. */
if(anum % num_in_batch==0)
{
/* Only for the non-first batches: move the start/end to the
"PREVIOUS" batch and remove the ending of current batch. */
if(is_first_batch==0)
{
startend[0]=startend[2];
startend[1]=startend[3];
}
/* Put this token at the start of this batch and set the end of
this batch to be NULL. */
startend[3]=NULL;
startend[2]=token;
}
/* This is the last element of this batch, write startend[3] and
remove the 'isfirstbatch' flag. */
if(anum % num_in_batch == num_in_batch-1)
{ startend[3]=token; is_first_batch=0; }
/* For a check:
printf("%zu: %s (%zu of %zu)\n"
" %s\n %s\n %s\n %s\n\n", anum,
token, (anum%num_in_batch)+1, num_in_batch, startend[0],
startend[1], startend[2], startend[3]);
*/
/* If the target is reached, break out of the loop. */
if( !strcmp(target, token) ) { target_found=1; break; }
/* Go to the next token. */
++anum; /* Count of all tokens. */
token=strtok_r(NULL, delimiters, &saveptr);
}
while(token);
/* We need to return a non-empty output only when the target was found
and a previous batch exists. */
if(target_found && startend[0])
{
/* Find the positions of the start and end of the output string
within the (copied) input string and from that measure the length
of the output string. */
starti=startend[0]-cp;
endi=startend[1]+strlen(startend[1])-cp;
outlen=endi-starti;
/* Allocate the output and copy the input into it. */
out=gal_pointer_allocate(GAL_TYPE_STRING, outlen+1, 0, __func__,
"out");
memcpy(out, &list[starti], outlen);
out[outlen]='\0';
}
else out=NULL;
/* Clean up and return. */
free(cp);
return out;
}
/* Return the previous word in the given list. */
static char *
makeplugin_text_prev(const char *caller, unsigned int argc, char **argv)
{
char *target=argv[0], *list=argv[1];
/* Sanity check. */
if(makeplugin_sanity_check(argv, 2)) return NULL;
/* Parse the input list. */
return makeplugin_text_prev_batch_work(target, 1, list);
}
/* Return the previous word in the given list. */
static char *
makeplugin_text_prev_batch(const char *caller, unsigned int argc,
char **argv)
{
size_t num=0;
void *nptr;
char *target=argv[0], *numstr=argv[1], *list=argv[2];
/* Sanity check. */
if(makeplugin_sanity_check(argv, 3)) return NULL;
/* Interpret the number. */
nptr=#
if( gal_type_from_string(&nptr, numstr, GAL_TYPE_SIZE_T) )
{
fprintf(stderr, "ast-text-prev-batch: '%s' could not be read as "
"an unsigned integer", numstr);
exit(1);
}
/* In case the number is 0, return an error message. */
if(num==0)
{
fprintf(stderr, "ast-text-prev-batch: the given number of "
"elements in each batch (0) is undefined, please give a "
"positive integer");
exit(1);
}
/* Generate the outputs.*/
return makeplugin_text_prev_batch_work(target, num, list);
}
/* Return the previous elements in the list based on the available RAM and
the amount of RAM each invocation needs (in Gigabytes of normal decimal
1000s base, not 1024s). To get the amount of RAM of each invocation, you
can use the command below (which will return the maximum necessary RAM
in Kilobytes).
/usr/bin/time --format=%M command ....
To convert this to Gigabytes, you can use this command (just replace the
number):
echo "2374764" | awk '{print $1*1e3/1e9}'
Afterwards, try to round it upwards (so some RAM is always left for the
OS).
*/
static char *
makeplugin_text_prev_batch_by_ram(const char *caller, unsigned int argc,
char **argv)
{
void *nptr;
float needed_gb;
size_t num, ram_b=gal_checkset_ram_available(1);
char *target=argv[0], *ramstr=argv[1], *list=argv[2];
/* Sanity check. */
if(makeplugin_sanity_check(argv, 3)) return NULL;
/* Interpret the number. */
nptr=&needed_gb;
if( gal_type_from_string(&nptr, ramstr, GAL_TYPE_FLOAT32) )
{
fprintf(stderr, "'%s' could not be read as an unsigned "
"integer", ramstr);
exit(1);
}
/* Estimate the number of words in each batch (to be run in parallel if
this function is used in targets list) and call the final function. */
num=ram_b/((size_t)(needed_gb*1e9));
if(num==0) num=1; /* needed_gb > ram_b: no parallelization! */
return makeplugin_text_prev_batch_work(target, num, list);
}
/**********************************************************************/
/*************** FITS functions ***************/
/**********************************************************************/
/* Select the input files that have the requested value(s) in the requested
keywords. */
static int
makeplugin_fits_check_input(char **argv, size_t numargs, char *name)
{
char *c;
size_t i;
/* Sanity check. */
if(makeplugin_sanity_check(argv, numargs)) return 1;
/* If the HDU is empty, print a warning and don't continue. */
for(i=0;i<numargs;++i)
{
/* We need to skip white-space characters. */
c=argv[i]; do if(isspace(*c)) ++c; else break; while(1);
if(*c=='\0')
{
if(i>0) /* Message only necessary for first argument. */
{
fprintf(stderr, "%s: argument %zu is empty", name, i+1);
exit(1);
}
return 1;
}
}
/* If control reaches here, everything is good. */
return 0;
}
/* Select files, were a certain keyword has a certain value. It takes four
arguments:
0. Keyword name.
1. Keyword value(s).
2. HDU (fixed in all files).
3. List of files. */
static char *
makeplugin_fits_with_keyvalue(const char *caller, unsigned int argc,
char **argv)
{
gal_list_str_t *outlist=NULL;
char *name=gal_txt_trim_space(argv[0]);
gal_list_str_t *files=NULL, *values=NULL;
char *out, *hdu=gal_txt_trim_space(argv[2]);
/* If any of the inputs are empty, then don't bother continuing. */
if( makeplugin_fits_check_input(argv, 4, fits_with_keyvalue_name) )
return NULL;
/* Extract the components in the arguments with possibly multiple
values and find the output files. */
files=gal_list_str_extract(argv[3]);
values=gal_list_str_extract(argv[1]);
outlist=gal_fits_with_keyvalue(files, hdu, name, values, NULL);
/* Write the output string. */
out=gal_list_str_cat(outlist, ' ');
/* Clean up and return. */
gal_list_str_free(files, 1);
gal_list_str_free(values, 1);
gal_list_str_free(outlist, 1);
return out;
}
/* Return the unique values given to a certain keyword in many FITS
files. It takes three arguments.
0. Keyword name.
1. HDU (fixed in all files).
2. List of files. */
static char *
makeplugin_fits_unique_keyvalues(const char *caller, unsigned int argc,
char **argv)
{
gal_list_str_t *files=NULL;
gal_list_str_t *outlist=NULL;
char *name=gal_txt_trim_space(argv[0]);
char *out, *hdu=gal_txt_trim_space(argv[1]);
/* If any of the inputs are empty, then don't bother continuing. */
if( makeplugin_fits_check_input(argv, 3, fits_unique_keyvalues_name) )
return NULL;
/* Extract the components in the arguments with possibly multiple
values and find the output files. */
files=gal_list_str_extract(argv[2]);
outlist=gal_fits_unique_keyvalues(files, hdu, name, NULL);
/* Write the output value. */
out=gal_list_str_cat(outlist, ' ');
/* Clean up and return. */
gal_list_str_free(files, 1);
gal_list_str_free(outlist, 1);
return out;
}
/**********************************************************************/
/******** High-level interface with Make *********/
/**********************************************************************/
int
libgnuastro_make_gmk_setup()
{
/* ------------ Basic useful text functions ------------ */
/* Return the input strings that contain the given string. */
gmk_add_function(text_contains_name, makeplugin_text_contains,
2, 2, GMK_FUNC_DEFAULT);
/* Return the input strings that DON'T contain the given string. */
gmk_add_function(text_not_contains_name, makeplugin_text_not_contains,
2, 2, GMK_FUNC_DEFAULT);
/* Convert input sting into upper-case. */
gmk_add_function(text_to_upper, makeplugin_text_to_upper,
1, 1, GMK_FUNC_DEFAULT);
/* Convert input string to lower-case. */
gmk_add_function(text_to_lower, makeplugin_text_to_lower,
1, 1, GMK_FUNC_DEFAULT);
/* Select previous item in list*/
gmk_add_function(text_prev, makeplugin_text_prev, 2, 2,
GMK_FUNC_DEFAULT);
/* Select batch of previous 'num' elements in list. */
gmk_add_function(text_prev_batch, makeplugin_text_prev_batch,
3, 3, GMK_FUNC_DEFAULT);
/* Select batch */
gmk_add_function(text_prev_batch_by_ram,
makeplugin_text_prev_batch_by_ram,
3, 3, GMK_FUNC_DEFAULT);
/* ------------ Gnuastro related functions ------------ */
/* Return 1 if Gnuastro has the requested version. */
gmk_add_function(version_is_name, makeplugin_version_is,
1, 1, GMK_FUNC_DEFAULT);
/* Select files, were a certain keyword has a certain value. It takes
four arguments. */
gmk_add_function(fits_with_keyvalue_name, makeplugin_fits_with_keyvalue,
4, 4, GMK_FUNC_DEFAULT);
/* Return the unique values given to a certain keyword in many FITS
files. */
gmk_add_function(fits_unique_keyvalues_name,
makeplugin_fits_unique_keyvalues,
3, 3, GMK_FUNC_DEFAULT);
/* Everything is good, return 1 (success). */
return 1;
}
|