Skip to content

Commit 7381e3e

Browse files
jcupittjcupitt
committed
improve error and logging messages
try to make error and logging messages more consistent in terms of punctuation and capitalisation
1 parent 9f377b0 commit 7381e3e

File tree

5 files changed

+155
-157
lines changed

5 files changed

+155
-157
lines changed

‎src/dicom-data.c‎

Lines changed: 64 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -171,8 +171,8 @@ DcmElement *dcm_element_create(DcmError **error, uint32_t tag, DcmVR vr)
171171
{
172172
if (!dcm_is_valid_vr_for_tag(vr, tag)) {
173173
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
174-
"Incorrect tag",
175-
"Tag %08x does not allow VR %s",
174+
"incorrect tag",
175+
"tag %08x does not allow VR %s",
176176
tag,
177177
dcm_dict_str_from_vr(vr));
178178
return NULL;
@@ -192,7 +192,7 @@ DcmElement *dcm_element_create(DcmError **error, uint32_t tag, DcmVR vr)
192192
void dcm_element_destroy(DcmElement *element)
193193
{
194194
if (element) {
195-
dcm_log_debug("Destroy Data Element '%08x'.", element->tag);
195+
dcm_log_debug("destroy Data Element '%08x'", element->tag);
196196
if(element->sequence_pointer) {
197197
dcm_sequence_destroy(element->sequence_pointer);
198198
}
@@ -256,8 +256,8 @@ static bool element_check_index(DcmError **error,
256256
{
257257
if (index >= element->vm) {
258258
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
259-
"Data Element index out of range",
260-
"Element tag %08x has VM of %d, index %d is out of range",
259+
"data element index out of range",
260+
"element tag %08x has VM of %d, index %d is out of range",
261261
element->tag,
262262
element->vm,
263263
index);
@@ -275,8 +275,8 @@ static bool element_check_string(DcmError **error,
275275
if (vr_class != DCM_VR_CLASS_STRING_MULTI &&
276276
vr_class != DCM_VR_CLASS_STRING_SINGLE) {
277277
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
278-
"Data Element is not string",
279-
"Element tag %08x has VR %s with no string value",
278+
"data element is not string",
279+
"element tag %08x has VR %s with no string value",
280280
element->tag,
281281
dcm_dict_str_from_vr(element->vr));
282282
return false;
@@ -291,8 +291,8 @@ static bool element_check_assigned(DcmError **error,
291291
{
292292
if (!element->assigned) {
293293
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
294-
"Data Element not assigned a value",
295-
"Element tag %08x has not been assigned a value",
294+
"data element not assigned a value",
295+
"element tag %08x has not been assigned a value",
296296
element->tag);
297297
return false;
298298
}
@@ -306,8 +306,8 @@ static bool element_check_not_assigned(DcmError **error,
306306
{
307307
if (element->assigned) {
308308
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
309-
"Data Element assigned twice",
310-
"Element tag %08x has been previously assigned a value",
309+
"data element assigned twice",
310+
"element tag %08x has been previously assigned a value",
311311
element->tag);
312312
return false;
313313
}
@@ -381,8 +381,8 @@ static bool dcm_element_validate(DcmError **error, DcmElement *element)
381381

382382
if (!dcm_is_valid_vr_for_tag(element->vr, element->tag)) {
383383
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
384-
"Data Element validation failed",
385-
"Bad VR for tag %08x, should be %s",
384+
"data element validation failed",
385+
"bad VR for tag %08x, should be %s",
386386
element->tag,
387387
dcm_dict_str_from_vr(element->vr));
388388
return false;
@@ -392,8 +392,8 @@ static bool dcm_element_validate(DcmError **error, DcmElement *element)
392392
vr_class == DCM_VR_CLASS_NUMERIC_INTEGER) {
393393
if (element->length != element->vm * dcm_dict_vr_size(element->vr)) {
394394
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
395-
"Data Element validation failed",
396-
"Bad length for numeric tag %08x",
395+
"data element validation failed",
396+
"bad length for numeric tag %08x",
397397
element->tag);
398398
return false;
399399
}
@@ -450,8 +450,8 @@ bool dcm_element_set_value_string_multi(DcmError **error,
450450
DcmVRClass vr_class = dcm_dict_vr_class(element->vr);
451451
if (vr_class != DCM_VR_CLASS_STRING_MULTI) {
452452
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
453-
"Data Element is not multi-valued string",
454-
"Element tag %08x has VR %s with only a string value",
453+
"data element is not multi-valued string",
454+
"element tag %08x has VR %s with only a string value",
455455
element->tag,
456456
dcm_dict_str_from_vr(element->vr));
457457
return false;
@@ -632,8 +632,8 @@ static bool element_check_numeric(DcmError **error,
632632
if (vr_class != DCM_VR_CLASS_NUMERIC_DECIMAL &&
633633
vr_class != DCM_VR_CLASS_NUMERIC_INTEGER) {
634634
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
635-
"Data Element is not numeric",
636-
"Element tag %08x is not numeric",
635+
"data element is not numeric",
636+
"element tag %08x is not numeric",
637637
element->tag);
638638
return false;
639639
}
@@ -650,8 +650,8 @@ static bool element_check_integer(DcmError **error,
650650
}
651651
if (element->vr == DCM_VR_FL || element->vr == DCM_VR_FD) {
652652
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
653-
"Data Element is not integer",
654-
"Element tag %08x is not integer",
653+
"data element is not integer",
654+
"element tag %08x is not integer",
655655
element->tag);
656656
return false;
657657
}
@@ -785,8 +785,8 @@ static bool element_check_float(DcmError **error,
785785
{
786786
if (element->vr != DCM_VR_FL && element->vr != DCM_VR_FD) {
787787
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
788-
"Data Element is not float",
789-
"Element tag %08x is not one of the float types",
788+
"data element is not float",
789+
"element tag %08x is not one of the float types",
790790
element->tag);
791791
return false;
792792
}
@@ -852,8 +852,8 @@ static bool element_check_binary(DcmError **error,
852852
DcmVRClass vr_class = dcm_dict_vr_class(element->vr);
853853
if (vr_class != DCM_VR_CLASS_BINARY) {
854854
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
855-
"Data Element is not binary",
856-
"Element tag %08x does not have a binary value",
855+
"data element is not binary",
856+
"element tag %08x does not have a binary value",
857857
element->tag);
858858
return false;
859859
}
@@ -941,8 +941,8 @@ bool dcm_element_set_value(DcmError **error,
941941
size = dcm_dict_vr_size(element->vr);
942942
if (length % size != 0) {
943943
dcm_error_set(error, DCM_ERROR_CODE_PARSE,
944-
"Reading of Data Element failed",
945-
"Bad byte length for numeric type");
944+
"reading of data element failed",
945+
"bad byte length for numeric type");
946946
return false;
947947
}
948948
if (!dcm_element_set_value_numeric_multi(error,
@@ -968,8 +968,8 @@ bool dcm_element_set_value(DcmError **error,
968968
case DCM_VR_CLASS_SEQUENCE:
969969
default:
970970
dcm_error_set(error, DCM_ERROR_CODE_PARSE,
971-
"Reading of Data Element failed",
972-
"Data Element '%08x' has unexpected "
971+
"reading of data element failed",
972+
"data element '%08x' has unexpected "
973973
"Value Representation", element->tag);
974974
return false;
975975
}
@@ -985,8 +985,8 @@ static bool element_check_sequence(DcmError **error,
985985
DcmVRClass vr_class = dcm_dict_vr_class(element->vr);
986986
if (vr_class != DCM_VR_CLASS_SEQUENCE) {
987987
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
988-
"Data Element is not seeuence",
989-
"Element tag %08x does not have a seeuence value",
988+
"data element is not seeuence",
989+
"element tag %08x does not have a seeuence value",
990990
element->tag);
991991
return false;
992992
}
@@ -1053,7 +1053,7 @@ DcmElement *dcm_element_clone(DcmError **error, const DcmElement *element)
10531053
uint32_t i;
10541054
DcmSequence *from_seq;
10551055

1056-
dcm_log_debug("Clone Data Element '%08x'.", element->tag);
1056+
dcm_log_debug("clone Data Element '%08x'", element->tag);
10571057

10581058
DcmElement *clone = dcm_element_create(error, element->tag, element->vr);
10591059
if (clone == NULL) {
@@ -1264,7 +1264,7 @@ char *dcm_element_value_to_string(const DcmElement *element)
12641264
break;
12651265

12661266
default:
1267-
dcm_log_warning("Unexpected Value Representation.");
1267+
dcm_log_warning("unexpected Value Representation");
12681268
}
12691269

12701270
if (element->vm > 1) {
@@ -1363,7 +1363,7 @@ void dcm_element_print(const DcmElement *element, int indentation)
13631363

13641364
DcmDataSet *dcm_dataset_create(DcmError **error)
13651365
{
1366-
dcm_log_debug("Create Data Set.");
1366+
dcm_log_debug("create Data Set");
13671367
DcmDataSet *dataset = DCM_NEW(error, DcmDataSet);
13681368
if (dataset == NULL) {
13691369
return NULL;
@@ -1376,7 +1376,7 @@ DcmDataSet *dcm_dataset_create(DcmError **error)
13761376

13771377
DcmDataSet *dcm_dataset_clone(DcmError **error, const DcmDataSet *dataset)
13781378
{
1379-
dcm_log_debug("Clone Data Set.");
1379+
dcm_log_debug("clone Data Set");
13801380
DcmDataSet *cloned_dataset = dcm_dataset_create(error);
13811381
if (cloned_dataset == NULL) {
13821382
return NULL;
@@ -1404,8 +1404,7 @@ DcmDataSet *dcm_dataset_clone(DcmError **error, const DcmDataSet *dataset)
14041404
static bool dataset_check_not_locked(DcmError **error, DcmDataSet *dataset)
14051405
{
14061406
if (dataset->is_locked) {
1407-
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
1408-
"Data Set is locked", "");
1407+
dcm_error_set(error, DCM_ERROR_CODE_INVALID, "data set is locked", "");
14091408
return false;
14101409
}
14111410

@@ -1433,8 +1432,8 @@ bool dcm_dataset_insert(DcmError **error,
14331432
DcmElement *matched_element = dcm_dataset_contains(dataset, element->tag);
14341433
if (matched_element) {
14351434
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
1436-
"Element already exists",
1437-
"Inserting Data Element '%08x' into Data Set failed",
1435+
"element already exists",
1436+
"inserting data element '%08x' into data set failed",
14381437
element->tag);
14391438
return false;
14401439
}
@@ -1448,13 +1447,13 @@ bool dcm_dataset_insert(DcmError **error,
14481447
DcmElement *dcm_dataset_get(DcmError **error,
14491448
const DcmDataSet *dataset, uint32_t tag)
14501449
{
1451-
dcm_log_debug("Get Data Element '%08x' from Data Set.", tag);
1450+
dcm_log_debug("get Data Element '%08x' from data set", tag);
14521451

14531452
DcmElement *element = dcm_dataset_contains(dataset, tag);
14541453
if (element == NULL) {
14551454
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
1456-
"Could not find Data Element",
1457-
"Getting Data Element '%08x' from Data Set failed",
1455+
"could not find data element",
1456+
"getting data element '%08x' from data set failed",
14581457
tag);
14591458
}
14601459

@@ -1465,7 +1464,7 @@ DcmElement *dcm_dataset_get(DcmError **error,
14651464
DcmElement *dcm_dataset_get_clone(DcmError **error,
14661465
const DcmDataSet *dataset, uint32_t tag)
14671466
{
1468-
dcm_log_debug("Copy Data Element '%08x' from Data Set.", tag);
1467+
dcm_log_debug("copy data element '%08x' from data set", tag);
14691468

14701469
DcmElement *element = dcm_dataset_get(error, dataset, tag);
14711470
if (element == NULL) {
@@ -1548,7 +1547,7 @@ void dcm_dataset_print(const DcmDataSet *dataset, int indentation)
15481547
for(i = 0; i < n; i++) {
15491548
element = dcm_dataset_get(NULL, dataset, tags[i]);
15501549
if (element == NULL) {
1551-
dcm_log_warning("Missing tag.");
1550+
dcm_log_warning("missing tag");
15521551
free(tags);
15531552
return;
15541553
}
@@ -1599,8 +1598,8 @@ DcmSequence *dcm_sequence_create(DcmError **error)
15991598
utarray_new(items, &sequence_item_icd);
16001599
if (items == NULL) {
16011600
dcm_error_set(error, DCM_ERROR_CODE_NOMEM,
1602-
"Out of memory",
1603-
"Creation of Sequence failed");
1601+
"out of memory",
1602+
"creation of Sequence failed");
16041603
free(seq);
16051604
return NULL;
16061605
}
@@ -1615,7 +1614,7 @@ static bool sequence_check_not_locked(DcmError **error, DcmSequence *seq)
16151614
{
16161615
if (seq->is_locked) {
16171616
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
1618-
"Sequence is locked", "");
1617+
"sequence is locked", "");
16191618
return false;
16201619
}
16211620

@@ -1629,7 +1628,7 @@ bool dcm_sequence_append(DcmError **error, DcmSequence *seq, DcmDataSet *item)
16291628
return false;
16301629
}
16311630

1632-
dcm_log_debug("Append item to Sequence.");
1631+
dcm_log_debug("append item to sequence");
16331632

16341633
/**
16351634
* The SequenceItem is just a thin wrapper around a DcmDataSet object as a
@@ -1660,23 +1659,23 @@ static struct SequenceItem *sequence_check_index(DcmError **error,
16601659
uint32_t length = utarray_len(seq->items);
16611660
if (index >= length) {
16621661
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
1663-
"Item of Sequence invalid",
1664-
"Index %i exceeds length of sequence %i",
1662+
"item of sequence invalid",
1663+
"index %i exceeds length of sequence %i",
16651664
index, length);
16661665
return NULL;
16671666
}
16681667

16691668
struct SequenceItem *seq_item = sequence_get_index(seq, index);
16701669
if (seq_item == NULL) {
16711670
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
1672-
"Item of Sequence invalid",
1673-
"Getting item #%i of Sequence failed", index);
1671+
"item of sequence invalid",
1672+
"getting item #%i of Sequence failed", index);
16741673
return NULL;
16751674
}
16761675
if (seq_item->dataset == NULL) {
16771676
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
1678-
"Item of Sequence invalid",
1679-
"Getting item #%i of Sequence failed", index);
1677+
"item of sequence invalid",
1678+
"getting item #%i of sequence failed", index);
16801679
return NULL;
16811680
}
16821681

@@ -1744,7 +1743,7 @@ bool dcm_sequence_remove(DcmError **error, DcmSequence *seq, uint32_t index)
17441743
return false;
17451744
}
17461745

1747-
dcm_log_debug("Remove item #%i from Sequence.", index);
1746+
dcm_log_debug("remove item #%i from Sequence", index);
17481747

17491748
utarray_erase(seq->items, index, 1);
17501749

@@ -1800,36 +1799,36 @@ DcmFrame *dcm_frame_create(DcmError **error,
18001799
{
18011800
if (data == NULL || length == 0) {
18021801
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
1803-
"Constructing Frame Item failed",
1804-
"Pixel data cannot be empty");
1802+
"constructing frame item failed",
1803+
"PixelData cannot be empty");
18051804
return NULL;
18061805
}
18071806

18081807
if (bits_allocated != 1 && bits_allocated % 8 != 0) {
18091808
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
1810-
"Constructing Frame Item failed",
1811-
"Wrong number of bits allocated");
1809+
"constructing frame item failed",
1810+
"wrong number of bits allocated");
18121811
return NULL;
18131812
}
18141813

18151814
if (bits_stored != 1 && bits_stored % 8 != 0) {
18161815
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
1817-
"Constructing Frame Item failed",
1818-
"Wrong number of bits stored");
1816+
"constructing frame item failed",
1817+
"wrong number of bits stored");
18191818
return NULL;
18201819
}
18211820

18221821
if (pixel_representation != 0 && pixel_representation != 1) {
18231822
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
1824-
"Constructing Frame Item failed",
1825-
"Wrong pixel representation");
1823+
"constructing frame item failed",
1824+
"wrong pixel representation");
18261825
return NULL;
18271826
}
18281827

18291828
if (planar_configuration != 0 && planar_configuration != 1) {
18301829
dcm_error_set(error, DCM_ERROR_CODE_INVALID,
1831-
"Constructing Frame Item failed",
1832-
"Wrong planar configuration");
1830+
"constructing frame item failed",
1831+
"wrong planar configuration");
18331832
return NULL;
18341833
}
18351834

0 commit comments

Comments
 (0)