Cleanup: comments (long lines) in blenkernel
[blender.git] / source / blender / blenkernel / intern / font.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup bke
22  */
23
24 #include <stdio.h>
25 #include <string.h>
26 #include <math.h>
27 #include <stdlib.h>
28 #include <wchar.h>
29 #include <wctype.h>
30
31 #include "CLG_log.h"
32
33 #include "MEM_guardedalloc.h"
34
35 #include "BLI_utildefines.h"
36 #include "BLI_path_util.h"
37 #include "BLI_listbase.h"
38 #include "BLI_ghash.h"
39 #include "BLI_string.h"
40 #include "BLI_string_utf8.h"
41 #include "BLI_math.h"
42 #include "BLI_threads.h"
43 #include "BLI_vfontdata.h"
44
45 #include "DNA_packedFile_types.h"
46 #include "DNA_curve_types.h"
47 #include "DNA_vfont_types.h"
48 #include "DNA_object_types.h"
49
50 #include "BKE_packedFile.h"
51 #include "BKE_library.h"
52 #include "BKE_font.h"
53 #include "BKE_global.h"
54 #include "BKE_main.h"
55 #include "BKE_anim.h"
56 #include "BKE_curve.h"
57
58 static CLG_LogRef LOG = {"bke.data_transfer"};
59 static ThreadRWMutex vfont_rwlock = BLI_RWLOCK_INITIALIZER;
60
61 /* The vfont code */
62 void BKE_vfont_free_data(struct VFont *vfont)
63 {
64   if (vfont->data) {
65     if (vfont->data->characters) {
66       GHashIterator gh_iter;
67       GHASH_ITER (gh_iter, vfont->data->characters) {
68         VChar *che = BLI_ghashIterator_getValue(&gh_iter);
69
70         while (che->nurbsbase.first) {
71           Nurb *nu = che->nurbsbase.first;
72           if (nu->bezt) {
73             MEM_freeN(nu->bezt);
74           }
75           BLI_freelinkN(&che->nurbsbase, nu);
76         }
77
78         MEM_freeN(che);
79       }
80
81       BLI_ghash_free(vfont->data->characters, NULL, NULL);
82     }
83
84     MEM_freeN(vfont->data);
85     vfont->data = NULL;
86   }
87
88   if (vfont->temp_pf) {
89     freePackedFile(vfont->temp_pf); /* NULL when the font file can't be found on disk */
90     vfont->temp_pf = NULL;
91   }
92 }
93
94 /** Free (or release) any data used by this font (does not free the font itself). */
95 void BKE_vfont_free(struct VFont *vf)
96 {
97   BKE_vfont_free_data(vf);
98
99   if (vf->packedfile) {
100     freePackedFile(vf->packedfile);
101     vf->packedfile = NULL;
102   }
103 }
104
105 void BKE_vfont_copy_data(Main *UNUSED(bmain),
106                          VFont *vfont_dst,
107                          const VFont *UNUSED(vfont_src),
108                          const int flag)
109 {
110   /* We never handle usercount here for own data. */
111   const int flag_subdata = flag | LIB_ID_CREATE_NO_USER_REFCOUNT;
112
113   /* Just to be sure, should not have any value actually after reading time. */
114   vfont_dst->temp_pf = NULL;
115
116   if (vfont_dst->packedfile) {
117     vfont_dst->packedfile = dupPackedFile(vfont_dst->packedfile);
118   }
119
120   if (vfont_dst->data) {
121     vfont_dst->data = BLI_vfontdata_copy(vfont_dst->data, flag_subdata);
122   }
123 }
124
125 static void *builtin_font_data = NULL;
126 static int builtin_font_size = 0;
127
128 bool BKE_vfont_is_builtin(struct VFont *vfont)
129 {
130   return STREQ(vfont->name, FO_BUILTIN_NAME);
131 }
132
133 void BKE_vfont_builtin_register(void *mem, int size)
134 {
135   builtin_font_data = mem;
136   builtin_font_size = size;
137 }
138
139 static PackedFile *get_builtin_packedfile(void)
140 {
141   if (!builtin_font_data) {
142     CLOG_ERROR(&LOG, "Internal error, builtin font not loaded");
143
144     return NULL;
145   }
146   else {
147     void *mem = MEM_mallocN(builtin_font_size, "vfd_builtin");
148
149     memcpy(mem, builtin_font_data, builtin_font_size);
150
151     return newPackedFileMemory(mem, builtin_font_size);
152   }
153 }
154
155 static VFontData *vfont_get_data(VFont *vfont)
156 {
157   if (vfont == NULL) {
158     return NULL;
159   }
160
161   /* And then set the data */
162   if (!vfont->data) {
163     PackedFile *pf;
164
165     BLI_rw_mutex_lock(&vfont_rwlock, THREAD_LOCK_WRITE);
166
167     if (vfont->data) {
168       /* Check data again, since it might have been already
169        * initialized from other thread (previous check is
170        * not accurate or threading, just prevents unneeded
171        * lock if all the data is here for sure).
172        */
173       BLI_rw_mutex_unlock(&vfont_rwlock);
174       return vfont->data;
175     }
176
177     if (BKE_vfont_is_builtin(vfont)) {
178       pf = get_builtin_packedfile();
179     }
180     else {
181       if (vfont->packedfile) {
182         pf = vfont->packedfile;
183
184         /* We need to copy a tmp font to memory unless it is already there */
185         if (vfont->temp_pf == NULL) {
186           vfont->temp_pf = dupPackedFile(pf);
187         }
188       }
189       else {
190         pf = newPackedFile(NULL, vfont->name, ID_BLEND_PATH_FROM_GLOBAL(&vfont->id));
191
192         if (vfont->temp_pf == NULL) {
193           vfont->temp_pf = newPackedFile(NULL, vfont->name, ID_BLEND_PATH_FROM_GLOBAL(&vfont->id));
194         }
195       }
196       if (!pf) {
197         CLOG_WARN(&LOG, "Font file doesn't exist: %s", vfont->name);
198
199         /* DON'T DO THIS
200          * missing file shouldn't modify path! - campbell */
201 #if 0
202         strcpy(vfont->name, FO_BUILTIN_NAME);
203 #endif
204         pf = get_builtin_packedfile();
205       }
206     }
207
208     if (pf) {
209       vfont->data = BLI_vfontdata_from_freetypefont(pf);
210       if (pf != vfont->packedfile) {
211         freePackedFile(pf);
212       }
213     }
214
215     BLI_rw_mutex_unlock(&vfont_rwlock);
216   }
217
218   return vfont->data;
219 }
220
221 /* Bad naming actually in this case... */
222 void BKE_vfont_init(VFont *vfont)
223 {
224   PackedFile *pf = get_builtin_packedfile();
225
226   if (pf) {
227     VFontData *vfd;
228
229     vfd = BLI_vfontdata_from_freetypefont(pf);
230     if (vfd) {
231       vfont->data = vfd;
232
233       BLI_strncpy(vfont->name, FO_BUILTIN_NAME, sizeof(vfont->name));
234     }
235
236     /* Free the packed file */
237     freePackedFile(pf);
238   }
239 }
240
241 VFont *BKE_vfont_load(Main *bmain, const char *filepath)
242 {
243   char filename[FILE_MAXFILE];
244   VFont *vfont = NULL;
245   PackedFile *pf;
246   bool is_builtin;
247
248   if (STREQ(filepath, FO_BUILTIN_NAME)) {
249     BLI_strncpy(filename, filepath, sizeof(filename));
250
251     pf = get_builtin_packedfile();
252     is_builtin = true;
253   }
254   else {
255     BLI_split_file_part(filepath, filename, sizeof(filename));
256     pf = newPackedFile(NULL, filepath, BKE_main_blendfile_path(bmain));
257
258     is_builtin = false;
259   }
260
261   if (pf) {
262     VFontData *vfd;
263
264     vfd = BLI_vfontdata_from_freetypefont(pf);
265     if (vfd) {
266       vfont = BKE_libblock_alloc(bmain, ID_VF, filename, 0);
267       vfont->data = vfd;
268
269       /* if there's a font name, use it for the ID name */
270       if (vfd->name[0] != '\0') {
271         BLI_strncpy(vfont->id.name + 2, vfd->name, sizeof(vfont->id.name) - 2);
272       }
273       BLI_strncpy(vfont->name, filepath, sizeof(vfont->name));
274
275       /* if autopack is on store the packedfile in de font structure */
276       if (!is_builtin && (G.fileflags & G_FILE_AUTOPACK)) {
277         vfont->packedfile = pf;
278       }
279
280       /* Do not add FO_BUILTIN_NAME to temporary listbase */
281       if (!STREQ(filename, FO_BUILTIN_NAME)) {
282         vfont->temp_pf = newPackedFile(NULL, filepath, BKE_main_blendfile_path(bmain));
283       }
284     }
285
286     /* Free the packed file */
287     if (!vfont || vfont->packedfile != pf) {
288       freePackedFile(pf);
289     }
290   }
291
292   return vfont;
293 }
294
295 VFont *BKE_vfont_load_exists_ex(struct Main *bmain, const char *filepath, bool *r_exists)
296 {
297   VFont *vfont;
298   char str[FILE_MAX], strtest[FILE_MAX];
299
300   BLI_strncpy(str, filepath, sizeof(str));
301   BLI_path_abs(str, BKE_main_blendfile_path(bmain));
302
303   /* first search an identical filepath */
304   for (vfont = bmain->fonts.first; vfont; vfont = vfont->id.next) {
305     BLI_strncpy(strtest, vfont->name, sizeof(vfont->name));
306     BLI_path_abs(strtest, ID_BLEND_PATH(bmain, &vfont->id));
307
308     if (BLI_path_cmp(strtest, str) == 0) {
309       id_us_plus(&vfont->id); /* officially should not, it doesn't link here! */
310       if (r_exists) {
311         *r_exists = true;
312       }
313       return vfont;
314     }
315   }
316
317   if (r_exists) {
318     *r_exists = false;
319   }
320   return BKE_vfont_load(bmain, filepath);
321 }
322
323 VFont *BKE_vfont_load_exists(struct Main *bmain, const char *filepath)
324 {
325   return BKE_vfont_load_exists_ex(bmain, filepath, NULL);
326 }
327
328 void BKE_vfont_make_local(Main *bmain, VFont *vfont, const bool lib_local)
329 {
330   BKE_id_make_local_generic(bmain, &vfont->id, true, lib_local);
331 }
332
333 static VFont *which_vfont(Curve *cu, CharInfo *info)
334 {
335   switch (info->flag & (CU_CHINFO_BOLD | CU_CHINFO_ITALIC)) {
336     case CU_CHINFO_BOLD:
337       return cu->vfontb ? cu->vfontb : cu->vfont;
338     case CU_CHINFO_ITALIC:
339       return cu->vfonti ? cu->vfonti : cu->vfont;
340     case (CU_CHINFO_BOLD | CU_CHINFO_ITALIC):
341       return cu->vfontbi ? cu->vfontbi : cu->vfont;
342     default:
343       return cu->vfont;
344   }
345 }
346
347 VFont *BKE_vfont_builtin_get(void)
348 {
349   VFont *vfont;
350
351   for (vfont = G_MAIN->fonts.first; vfont; vfont = vfont->id.next) {
352     if (BKE_vfont_is_builtin(vfont)) {
353       return vfont;
354     }
355   }
356
357   return BKE_vfont_load(G_MAIN, FO_BUILTIN_NAME);
358 }
359
360 static VChar *find_vfont_char(VFontData *vfd, unsigned int character)
361 {
362   return BLI_ghash_lookup(vfd->characters, POINTER_FROM_UINT(character));
363 }
364
365 static void build_underline(Curve *cu,
366                             ListBase *nubase,
367                             const rctf *rect,
368                             float yofs,
369                             float rot,
370                             int charidx,
371                             short mat_nr,
372                             const float font_size)
373 {
374   Nurb *nu2;
375   BPoint *bp;
376
377   nu2 = (Nurb *)MEM_callocN(sizeof(Nurb), "underline_nurb");
378   nu2->resolu = cu->resolu;
379   nu2->bezt = NULL;
380   nu2->knotsu = nu2->knotsv = NULL;
381   nu2->flag = CU_2D;
382   nu2->charidx = charidx + 1000;
383   if (mat_nr > 0) {
384     nu2->mat_nr = mat_nr - 1;
385   }
386   nu2->pntsu = 4;
387   nu2->pntsv = 1;
388   nu2->orderu = 4;
389   nu2->orderv = 1;
390   nu2->flagu = CU_NURB_CYCLIC;
391
392   bp = (BPoint *)MEM_calloc_arrayN(4, sizeof(BPoint), "underline_bp");
393
394   copy_v4_fl4(bp[0].vec, rect->xmin, (rect->ymax + yofs), 0.0f, 1.0f);
395   copy_v4_fl4(bp[1].vec, rect->xmax, (rect->ymax + yofs), 0.0f, 1.0f);
396   copy_v4_fl4(bp[2].vec, rect->xmax, (rect->ymin + yofs), 0.0f, 1.0f);
397   copy_v4_fl4(bp[3].vec, rect->xmin, (rect->ymin + yofs), 0.0f, 1.0f);
398
399   nu2->bp = bp;
400   BLI_addtail(nubase, nu2);
401
402   if (rot != 0.0f) {
403     float si, co;
404     int i;
405
406     si = sinf(rot);
407     co = cosf(rot);
408
409     for (i = nu2->pntsu; i > 0; i--) {
410       float *fp;
411       float x, y;
412
413       fp = bp->vec;
414
415       x = fp[0] - rect->xmin;
416       y = fp[1] - rect->ymin;
417
418       fp[0] = (+co * x + si * y) + rect->xmin;
419       fp[1] = (-si * x + co * y) + rect->ymin;
420
421       bp++;
422     }
423
424     bp = nu2->bp;
425   }
426
427   mul_v2_fl(bp[0].vec, font_size);
428   mul_v2_fl(bp[1].vec, font_size);
429   mul_v2_fl(bp[2].vec, font_size);
430   mul_v2_fl(bp[3].vec, font_size);
431 }
432
433 static void buildchar(Curve *cu,
434                       ListBase *nubase,
435                       unsigned int character,
436                       CharInfo *info,
437                       float ofsx,
438                       float ofsy,
439                       float rot,
440                       int charidx,
441                       const float fsize)
442 {
443   BezTriple *bezt1, *bezt2;
444   Nurb *nu1 = NULL, *nu2 = NULL;
445   float *fp, shear, x, si, co;
446   VFontData *vfd = NULL;
447   VChar *che = NULL;
448   int i;
449
450   vfd = vfont_get_data(which_vfont(cu, info));
451   if (!vfd) {
452     return;
453   }
454
455   /* make a copy at distance ofsx, ofsy with shear */
456   shear = cu->shear;
457   si = sinf(rot);
458   co = cosf(rot);
459
460   che = find_vfont_char(vfd, character);
461
462   /* Select the glyph data */
463   if (che) {
464     nu1 = che->nurbsbase.first;
465   }
466
467   /* Create the character */
468   while (nu1) {
469     bezt1 = nu1->bezt;
470     if (bezt1) {
471       nu2 = (Nurb *)MEM_mallocN(sizeof(Nurb), "duplichar_nurb");
472       if (nu2 == NULL) {
473         break;
474       }
475       memcpy(nu2, nu1, sizeof(struct Nurb));
476       nu2->resolu = cu->resolu;
477       nu2->bp = NULL;
478       nu2->knotsu = nu2->knotsv = NULL;
479       nu2->flag = CU_SMOOTH;
480       nu2->charidx = charidx;
481       if (info->mat_nr > 0) {
482         nu2->mat_nr = info->mat_nr - 1;
483       }
484       else {
485         nu2->mat_nr = 0;
486       }
487       /* nu2->trim.first = 0; */
488       /* nu2->trim.last = 0; */
489       i = nu2->pntsu;
490
491       bezt2 = (BezTriple *)MEM_malloc_arrayN(i, sizeof(BezTriple), "duplichar_bezt2");
492       if (bezt2 == NULL) {
493         MEM_freeN(nu2);
494         break;
495       }
496       memcpy(bezt2, bezt1, i * sizeof(struct BezTriple));
497       nu2->bezt = bezt2;
498
499       if (shear != 0.0f) {
500         bezt2 = nu2->bezt;
501
502         for (i = nu2->pntsu; i > 0; i--) {
503           bezt2->vec[0][0] += shear * bezt2->vec[0][1];
504           bezt2->vec[1][0] += shear * bezt2->vec[1][1];
505           bezt2->vec[2][0] += shear * bezt2->vec[2][1];
506           bezt2++;
507         }
508       }
509       if (rot != 0.0f) {
510         bezt2 = nu2->bezt;
511         for (i = nu2->pntsu; i > 0; i--) {
512           fp = bezt2->vec[0];
513
514           x = fp[0];
515           fp[0] = co * x + si * fp[1];
516           fp[1] = -si * x + co * fp[1];
517           x = fp[3];
518           fp[3] = co * x + si * fp[4];
519           fp[4] = -si * x + co * fp[4];
520           x = fp[6];
521           fp[6] = co * x + si * fp[7];
522           fp[7] = -si * x + co * fp[7];
523
524           bezt2++;
525         }
526       }
527       bezt2 = nu2->bezt;
528
529       if (info->flag & CU_CHINFO_SMALLCAPS_CHECK) {
530         const float sca = cu->smallcaps_scale;
531         for (i = nu2->pntsu; i > 0; i--) {
532           fp = bezt2->vec[0];
533           fp[0] *= sca;
534           fp[1] *= sca;
535           fp[3] *= sca;
536           fp[4] *= sca;
537           fp[6] *= sca;
538           fp[7] *= sca;
539           bezt2++;
540         }
541       }
542       bezt2 = nu2->bezt;
543
544       for (i = nu2->pntsu; i > 0; i--) {
545         fp = bezt2->vec[0];
546         fp[0] = (fp[0] + ofsx) * fsize;
547         fp[1] = (fp[1] + ofsy) * fsize;
548         fp[3] = (fp[3] + ofsx) * fsize;
549         fp[4] = (fp[4] + ofsy) * fsize;
550         fp[6] = (fp[6] + ofsx) * fsize;
551         fp[7] = (fp[7] + ofsy) * fsize;
552         bezt2++;
553       }
554
555       BLI_addtail(nubase, nu2);
556     }
557
558     nu1 = nu1->next;
559   }
560 }
561
562 int BKE_vfont_select_get(Object *ob, int *r_start, int *r_end)
563 {
564   Curve *cu = ob->data;
565   EditFont *ef = cu->editfont;
566   int start, end, direction;
567
568   if ((ob->type != OB_FONT) || (ef == NULL)) {
569     return 0;
570   }
571
572   BLI_assert(ef->len >= 0);
573   BLI_assert(ef->selstart >= 0 && ef->selstart <= ef->len + 1);
574   BLI_assert(ef->selend >= 0 && ef->selend <= ef->len + 1);
575   BLI_assert(ef->pos >= 0 && ef->pos <= ef->len);
576
577   if (ef->selstart == 0) {
578     return 0;
579   }
580
581   if (ef->selstart <= ef->selend) {
582     start = ef->selstart - 1;
583     end = ef->selend - 1;
584     direction = 1;
585   }
586   else {
587     start = ef->selend;
588     end = ef->selstart - 2;
589     direction = -1;
590   }
591
592   if (start == end + 1) {
593     return 0;
594   }
595   else {
596     BLI_assert(start < end + 1);
597     *r_start = start;
598     *r_end = end;
599     return direction;
600   }
601 }
602
603 void BKE_vfont_select_clamp(Object *ob)
604 {
605   Curve *cu = ob->data;
606   EditFont *ef = cu->editfont;
607
608   BLI_assert((ob->type == OB_FONT) && ef);
609
610   CLAMP_MAX(ef->pos, ef->len);
611   CLAMP_MAX(ef->selstart, ef->len + 1);
612   CLAMP_MAX(ef->selend, ef->len);
613 }
614
615 static float char_width(Curve *cu, VChar *che, CharInfo *info)
616 {
617   /* The character wasn't found, probably ascii = 0, then the width shall be 0 as well */
618   if (che == NULL) {
619     return 0.0f;
620   }
621   else if (info->flag & CU_CHINFO_SMALLCAPS_CHECK) {
622     return che->width * cu->smallcaps_scale;
623   }
624   else {
625     return che->width;
626   }
627 }
628
629 static void textbox_scale(TextBox *tb_dst, const TextBox *tb_src, float scale)
630 {
631   tb_dst->x = tb_src->x * scale;
632   tb_dst->y = tb_src->y * scale;
633   tb_dst->w = tb_src->w * scale;
634   tb_dst->h = tb_src->h * scale;
635 }
636
637 /**
638  * Used for storing per-line data for alignment & wrapping.
639  */
640 struct TempLineInfo {
641   float x_min;   /* left margin */
642   float x_max;   /* right margin */
643   int char_nr;   /* number of characters */
644   int wspace_nr; /* number of whitespaces of line */
645 };
646
647 typedef struct VFontToCurveIter {
648   int iteraction;
649   float scale_to_fit;
650   struct {
651     float min;
652     float max;
653   } bisect;
654   bool ok;
655   int status;
656 } VFontToCurveIter;
657
658 enum {
659   VFONT_TO_CURVE_INIT = 0,
660   VFONT_TO_CURVE_BISECT,
661   VFONT_TO_CURVE_SCALE_ONCE,
662   VFONT_TO_CURVE_DONE,
663 };
664
665 #define FONT_TO_CURVE_SCALE_ITERATIONS 20
666 #define FONT_TO_CURVE_SCALE_THRESHOLD 0.0001f
667
668 /**
669  * Font metric values explained:
670  *
671  * Baseline: Line where the text "rests", used as the origin vertical position for the glyphs.
672  * Em height: Space most glyphs should fit within.
673  * Ascent: the recommended distance above the baseline to fit most characters.
674  * Descent: the recommended distance below the baseline to fit most characters.
675  *
676  * We obtain ascent and descent from the font itself (FT_Face->ascender / face->height).
677  * And in some cases it is even the same value as FT_Face->bbox.yMax/yMin
678  * (font top and bottom respectively).
679  *
680  * The em_height here is relative to FT_Face->bbox.
681  */
682 #define ASCENT(vfd) ((vfd)->ascender * (vfd)->em_height)
683 #define DESCENT(vfd) ((vfd)->em_height - ASCENT(vfd))
684
685 static bool vfont_to_curve(Object *ob,
686                            Curve *cu,
687                            int mode,
688                            VFontToCurveIter *iter_data,
689                            ListBase *r_nubase,
690                            const wchar_t **r_text,
691                            int *r_text_len,
692                            bool *r_text_free,
693                            struct CharTrans **r_chartransdata)
694 {
695   EditFont *ef = cu->editfont;
696   EditFontSelBox *selboxes = NULL;
697   VFont *vfont, *oldvfont;
698   VFontData *vfd = NULL;
699   CharInfo *info = NULL, *custrinfo;
700   TextBox tb_scale;
701   bool use_textbox;
702   VChar *che;
703   struct CharTrans *chartransdata = NULL, *ct;
704   struct TempLineInfo *lineinfo;
705   float *f, xof, yof, xtrax, linedist;
706   float twidth = 0, maxlen = 0;
707   int i, slen, j;
708   int curbox;
709   int selstart, selend;
710   int cnr = 0, lnr = 0, wsnr = 0;
711   const wchar_t *mem = NULL;
712   wchar_t ascii;
713   bool ok = false;
714   const float font_size = cu->fsize * iter_data->scale_to_fit;
715   const float xof_scale = cu->xof / font_size;
716   const float yof_scale = cu->yof / font_size;
717   int last_line = -1;
718   /* Length of the text disregarding \n breaks. */
719   float current_line_length = 0.0f;
720   float longest_line_length = 0.0f;
721
722   /* Text at the beginning of the last used text-box (use for y-axis alignment).
723    * We overallocate by one to simplify logic of getting last char. */
724   int *i_textbox_array = MEM_callocN(sizeof(*i_textbox_array) * (cu->totbox + 1),
725                                      "TextBox initial char index");
726
727 #define MARGIN_X_MIN (xof_scale + tb_scale.x)
728 #define MARGIN_Y_MIN (yof_scale + tb_scale.y)
729
730   /* remark: do calculations including the trailing '\0' of a string
731    * because the cursor can be at that location */
732
733   BLI_assert(ob == NULL || ob->type == OB_FONT);
734
735   /* Set font data */
736   vfont = cu->vfont;
737
738   if (cu->str == NULL) {
739     return ok;
740   }
741   if (vfont == NULL) {
742     return ok;
743   }
744
745   vfd = vfont_get_data(vfont);
746
747   /* The VFont Data can not be found */
748   if (!vfd) {
749     return ok;
750   }
751
752   if (ef) {
753     slen = ef->len;
754     mem = ef->textbuf;
755     custrinfo = ef->textbufinfo;
756   }
757   else {
758     wchar_t *mem_tmp;
759     slen = cu->len_wchar;
760
761     /* Create unicode string */
762     mem_tmp = MEM_malloc_arrayN((slen + 1), sizeof(wchar_t), "convertedmem");
763     if (!mem_tmp) {
764       return ok;
765     }
766
767     BLI_strncpy_wchar_from_utf8(mem_tmp, cu->str, slen + 1);
768
769     if (cu->strinfo == NULL) { /* old file */
770       cu->strinfo = MEM_calloc_arrayN((slen + 4), sizeof(CharInfo), "strinfo compat");
771     }
772     custrinfo = cu->strinfo;
773     if (!custrinfo) {
774       return ok;
775     }
776
777     mem = mem_tmp;
778   }
779
780   if (cu->tb == NULL) {
781     cu->tb = MEM_calloc_arrayN(MAXTEXTBOX, sizeof(TextBox), "TextBox compat");
782   }
783
784   if (ef != NULL && ob != NULL) {
785     if (ef->selboxes) {
786       MEM_freeN(ef->selboxes);
787     }
788
789     if (BKE_vfont_select_get(ob, &selstart, &selend)) {
790       ef->selboxes_len = (selend - selstart) + 1;
791       ef->selboxes = MEM_calloc_arrayN(ef->selboxes_len, sizeof(EditFontSelBox), "font selboxes");
792     }
793     else {
794       ef->selboxes_len = 0;
795       ef->selboxes = NULL;
796     }
797
798     selboxes = ef->selboxes;
799   }
800
801   /* calc offset and rotation of each char */
802   ct = chartransdata = MEM_calloc_arrayN((slen + 1), sizeof(struct CharTrans), "buildtext");
803
804   /* We assume the worst case: 1 character per line (is freed at end anyway) */
805   lineinfo = MEM_malloc_arrayN((slen * 2 + 1), sizeof(*lineinfo), "lineinfo");
806
807   linedist = cu->linedist;
808
809   curbox = 0;
810   textbox_scale(&tb_scale, &cu->tb[curbox], 1.0f / font_size);
811   use_textbox = (tb_scale.w != 0.0f);
812
813   xof = MARGIN_X_MIN;
814   yof = MARGIN_Y_MIN;
815
816   xtrax = 0.5f * cu->spacing - 0.5f;
817
818   oldvfont = NULL;
819
820   for (i = 0; i < slen; i++) {
821     custrinfo[i].flag &= ~(CU_CHINFO_WRAP | CU_CHINFO_SMALLCAPS_CHECK | CU_CHINFO_OVERFLOW);
822   }
823
824   for (i = 0; i <= slen; i++) {
825   makebreak:
826     /* Characters in the list */
827     info = &custrinfo[i];
828     ascii = mem[i];
829     if (info->flag & CU_CHINFO_SMALLCAPS) {
830       ascii = towupper(ascii);
831       if (mem[i] != ascii) {
832         info->flag |= CU_CHINFO_SMALLCAPS_CHECK;
833       }
834     }
835
836     vfont = which_vfont(cu, info);
837
838     if (vfont == NULL) {
839       break;
840     }
841
842     if (vfont != oldvfont) {
843       vfd = vfont_get_data(vfont);
844       oldvfont = vfont;
845     }
846
847     /* VFont Data for VFont couldn't be found */
848     if (!vfd) {
849       MEM_freeN(chartransdata);
850       chartransdata = NULL;
851       MEM_freeN(lineinfo);
852       goto finally;
853     }
854
855     if (!ELEM(ascii, '\n', '\0')) {
856       BLI_rw_mutex_lock(&vfont_rwlock, THREAD_LOCK_READ);
857       che = find_vfont_char(vfd, ascii);
858       BLI_rw_mutex_unlock(&vfont_rwlock);
859
860       /*
861        * The character wasn't in the current curve base so load it
862        * But if the font is built-in then do not try loading since
863        * whole font is in the memory already
864        */
865       if (che == NULL && BKE_vfont_is_builtin(vfont) == false) {
866         BLI_rw_mutex_lock(&vfont_rwlock, THREAD_LOCK_WRITE);
867         /* Check it once again, char might have been already load
868          * between previous BLI_rw_mutex_unlock() and this BLI_rw_mutex_lock().
869          *
870          * Such a check should not be a bottleneck since it wouldn't
871          * happen often once all the chars are load.
872          */
873         if ((che = find_vfont_char(vfd, ascii)) == NULL) {
874           che = BLI_vfontchar_from_freetypefont(vfont, ascii);
875         }
876         BLI_rw_mutex_unlock(&vfont_rwlock);
877       }
878     }
879     else {
880       che = NULL;
881     }
882
883     twidth = char_width(cu, che, info);
884
885     /* Calculate positions */
886     if ((tb_scale.w != 0.0f) && (ct->dobreak == 0) &&
887         (((xof - tb_scale.x) + twidth) > xof_scale + tb_scale.w)) {
888       //      CLOG_WARN(&LOG, "linewidth exceeded: %c%c%c...", mem[i], mem[i+1], mem[i+2]);
889       for (j = i; j && (mem[j] != '\n') && (chartransdata[j].dobreak == 0); j--) {
890         bool dobreak = false;
891         if (mem[j] == ' ' || mem[j] == '-') {
892           ct -= (i - (j - 1));
893           cnr -= (i - (j - 1));
894           if (mem[j] == ' ') {
895             wsnr--;
896           }
897           if (mem[j] == '-') {
898             wsnr++;
899           }
900           i = j - 1;
901           xof = ct->xof;
902           ct[1].dobreak = 1;
903           custrinfo[i + 1].flag |= CU_CHINFO_WRAP;
904           dobreak = true;
905         }
906         else if (chartransdata[j].dobreak) {
907           //              CLOG_WARN(&LOG, "word too long: %c%c%c...", mem[j], mem[j+1], mem[j+2]);
908           ct->dobreak = 1;
909           custrinfo[i + 1].flag |= CU_CHINFO_WRAP;
910           ct -= 1;
911           cnr -= 1;
912           i--;
913           xof = ct->xof;
914           dobreak = true;
915         }
916         if (dobreak) {
917           if (tb_scale.h == 0.0f) {
918             /* Note: If underlined text is truncated away, the extra space is also truncated. */
919             custrinfo[i + 1].flag |= CU_CHINFO_OVERFLOW;
920           }
921           goto makebreak;
922         }
923       }
924     }
925
926     if (ascii == '\n' || ascii == 0 || ct->dobreak) {
927       ct->xof = xof;
928       ct->yof = yof;
929       ct->linenr = lnr;
930       ct->charnr = cnr;
931
932       yof -= linedist;
933
934       lineinfo[lnr].x_min = (xof - xtrax) - tb_scale.x;
935       lineinfo[lnr].x_max = tb_scale.w;
936       lineinfo[lnr].char_nr = cnr;
937       lineinfo[lnr].wspace_nr = wsnr;
938
939       CLAMP_MIN(maxlen, lineinfo[lnr].x_min);
940
941       if ((tb_scale.h != 0.0f) && ((-(yof - tb_scale.y)) > (tb_scale.h - linedist) - yof_scale)) {
942         if (cu->totbox > (curbox + 1)) {
943           maxlen = 0;
944           curbox++;
945           i_textbox_array[curbox] = i + 1;
946
947           textbox_scale(&tb_scale, &cu->tb[curbox], 1.0f / font_size);
948
949           yof = MARGIN_Y_MIN;
950         }
951         else if (last_line == -1) {
952           last_line = lnr + 1;
953           info->flag |= CU_CHINFO_OVERFLOW;
954         }
955       }
956
957       current_line_length += xof;
958       if (ct->dobreak) {
959         current_line_length += twidth;
960       }
961       else {
962         longest_line_length = MAX2(current_line_length, longest_line_length);
963         current_line_length = 0.0f;
964       }
965
966       /* XXX, has been unused for years, need to check if this is useful, r4613 r5282 - campbell */
967 #if 0
968       if (ascii == '\n')
969         xof = xof_scale;
970       else
971         xof = MARGIN_X_MIN;
972 #else
973       xof = MARGIN_X_MIN;
974 #endif
975       lnr++;
976       cnr = 0;
977       wsnr = 0;
978     }
979     else if (ascii == 9) { /* TAB */
980       float tabfac;
981
982       ct->xof = xof;
983       ct->yof = yof;
984       ct->linenr = lnr;
985       ct->charnr = cnr++;
986
987       tabfac = (xof - MARGIN_X_MIN + 0.01f);
988       tabfac = 2.0f * ceilf(tabfac / 2.0f);
989       xof = MARGIN_X_MIN + tabfac;
990     }
991     else {
992       EditFontSelBox *sb = NULL;
993       float wsfac;
994
995       ct->xof = xof;
996       ct->yof = yof;
997       ct->linenr = lnr;
998       ct->charnr = cnr++;
999
1000       if (selboxes && (i >= selstart) && (i <= selend)) {
1001         sb = &selboxes[i - selstart];
1002         sb->y = yof * font_size - linedist * font_size * 0.1f;
1003         sb->h = linedist * font_size;
1004         sb->w = xof * font_size;
1005       }
1006
1007       if (ascii == 32) {
1008         wsfac = cu->wordspace;
1009         wsnr++;
1010       }
1011       else {
1012         wsfac = 1.0f;
1013       }
1014
1015       /* Set the width of the character */
1016       twidth = char_width(cu, che, info);
1017
1018       xof += (twidth * wsfac * (1.0f + (info->kern / 40.0f))) + xtrax;
1019
1020       if (sb) {
1021         sb->w = (xof * font_size) - sb->w;
1022       }
1023     }
1024     ct++;
1025   }
1026   current_line_length += xof + twidth;
1027   longest_line_length = MAX2(current_line_length, longest_line_length);
1028
1029   cu->lines = 1;
1030   for (i = 0; i <= slen; i++) {
1031     ascii = mem[i];
1032     ct = &chartransdata[i];
1033     if (ascii == '\n' || ct->dobreak) {
1034       cu->lines++;
1035     }
1036   }
1037
1038   /* linedata is now: width of line */
1039
1040   if (cu->spacemode != CU_ALIGN_X_LEFT) {
1041     ct = chartransdata;
1042
1043     if (cu->spacemode == CU_ALIGN_X_RIGHT) {
1044       struct TempLineInfo *li;
1045
1046       for (i = 0, li = lineinfo; i < lnr; i++, li++) {
1047         li->x_min = (li->x_max - li->x_min) + xof_scale;
1048       }
1049
1050       for (i = 0; i <= slen; i++) {
1051         ct->xof += lineinfo[ct->linenr].x_min;
1052         ct++;
1053       }
1054     }
1055     else if (cu->spacemode == CU_ALIGN_X_MIDDLE) {
1056       struct TempLineInfo *li;
1057
1058       for (i = 0, li = lineinfo; i < lnr; i++, li++) {
1059         li->x_min = ((li->x_max - li->x_min) + xof_scale) / 2.0f;
1060       }
1061
1062       for (i = 0; i <= slen; i++) {
1063         ct->xof += lineinfo[ct->linenr].x_min;
1064         ct++;
1065       }
1066     }
1067     else if ((cu->spacemode == CU_ALIGN_X_FLUSH) && use_textbox) {
1068       struct TempLineInfo *li;
1069
1070       for (i = 0, li = lineinfo; i < lnr; i++, li++) {
1071         li->x_min = ((li->x_max - li->x_min) + xof_scale);
1072
1073         if (li->char_nr > 1) {
1074           li->x_min /= (float)(li->char_nr - 1);
1075         }
1076       }
1077       for (i = 0; i <= slen; i++) {
1078         for (j = i; (!ELEM(mem[j], '\0', '\n')) && (chartransdata[j].dobreak == 0) && (j < slen);
1079              j++) {
1080           /* do nothing */
1081         }
1082
1083         //              if ((mem[j] != '\n') && (mem[j])) {
1084         ct->xof += ct->charnr * lineinfo[ct->linenr].x_min;
1085         //              }
1086         ct++;
1087       }
1088     }
1089     else if ((cu->spacemode == CU_ALIGN_X_JUSTIFY) && use_textbox) {
1090       float curofs = 0.0f;
1091       for (i = 0; i <= slen; i++) {
1092         for (j = i; (mem[j]) && (mem[j] != '\n') && (chartransdata[j].dobreak == 0) && (j < slen);
1093              j++) {
1094           /* pass */
1095         }
1096
1097         if ((mem[j] != '\n') && ((chartransdata[j].dobreak != 0))) {
1098           if (mem[i] == ' ') {
1099             struct TempLineInfo *li;
1100
1101             li = &lineinfo[ct->linenr];
1102             curofs += ((li->x_max - li->x_min) + xof_scale) / (float)li->wspace_nr;
1103           }
1104           ct->xof += curofs;
1105         }
1106         if (mem[i] == '\n' || chartransdata[i].dobreak) {
1107           curofs = 0;
1108         }
1109         ct++;
1110       }
1111     }
1112   }
1113
1114   /* top-baseline is default, in this case, do nothing */
1115   if (cu->align_y != CU_ALIGN_Y_TOP_BASELINE) {
1116     if (tb_scale.h != 0.0f) {
1117       /* We need to loop all the text-boxes even the "full" ones.
1118        * This way they all get the same vertical padding. */
1119       for (int tb_index = 0; tb_index < cu->totbox; tb_index++) {
1120         struct CharTrans *ct_first, *ct_last;
1121         const int i_textbox = i_textbox_array[tb_index];
1122         const int i_textbox_next = i_textbox_array[tb_index + 1];
1123         const bool is_last_filled_textbox = ELEM(i_textbox_next, 0, slen + 1);
1124         int lines;
1125
1126         ct_first = chartransdata + i_textbox;
1127         ct_last = chartransdata + (is_last_filled_textbox ? slen : i_textbox_next - 1);
1128         lines = ct_last->linenr - ct_first->linenr + 1;
1129
1130         textbox_scale(&tb_scale, &cu->tb[tb_index], 1.0f / font_size);
1131         /* The initial Y origin of the textbox is hardcoded to 1.0f * text scale. */
1132         const float textbox_y_origin = 1.0f;
1133         float yoff = 0.0f;
1134
1135         switch (cu->align_y) {
1136           case CU_ALIGN_Y_TOP_BASELINE:
1137             break;
1138           case CU_ALIGN_Y_TOP:
1139             yoff = textbox_y_origin - ASCENT(vfd);
1140             break;
1141           case CU_ALIGN_Y_CENTER:
1142             yoff = ((((vfd->em_height + (lines - 1) * linedist) * 0.5f) - ASCENT(vfd)) -
1143                     (tb_scale.h * 0.5f) + textbox_y_origin);
1144             break;
1145           case CU_ALIGN_Y_BOTTOM_BASELINE:
1146             yoff = textbox_y_origin + ((lines - 1) * linedist) - tb_scale.h;
1147             break;
1148           case CU_ALIGN_Y_BOTTOM:
1149             yoff = textbox_y_origin + ((lines - 1) * linedist) - tb_scale.h + DESCENT(vfd);
1150             break;
1151         }
1152
1153         for (ct = ct_first; ct <= ct_last; ct++) {
1154           ct->yof += yoff;
1155         }
1156
1157         if (is_last_filled_textbox) {
1158           break;
1159         }
1160       }
1161     }
1162     else {
1163       /* Non text-box case handled separately. */
1164       float yoff = 0.0f;
1165
1166       switch (cu->align_y) {
1167         case CU_ALIGN_Y_TOP_BASELINE:
1168           break;
1169         case CU_ALIGN_Y_TOP:
1170           yoff = -ASCENT(vfd);
1171           break;
1172         case CU_ALIGN_Y_CENTER:
1173           yoff = ((vfd->em_height + (lnr - 1) * linedist) * 0.5f) - ASCENT(vfd);
1174           break;
1175         case CU_ALIGN_Y_BOTTOM_BASELINE:
1176           yoff = (lnr - 1) * linedist;
1177           break;
1178         case CU_ALIGN_Y_BOTTOM:
1179           yoff = (lnr - 1) * linedist + DESCENT(vfd);
1180           break;
1181       }
1182
1183       ct = chartransdata;
1184       for (i = 0; i <= slen; i++) {
1185         ct->yof += yoff;
1186         ct++;
1187       }
1188     }
1189   }
1190
1191   MEM_freeN(lineinfo);
1192   MEM_freeN(i_textbox_array);
1193
1194   /* TEXT ON CURVE */
1195   /* Note: Only OB_CURVE objects could have a path  */
1196   if (cu->textoncurve && cu->textoncurve->type == OB_CURVE) {
1197     BLI_assert(cu->textoncurve->runtime.curve_cache != NULL);
1198     if (cu->textoncurve->runtime.curve_cache != NULL &&
1199         cu->textoncurve->runtime.curve_cache->path != NULL) {
1200       float distfac, imat[4][4], imat3[3][3], cmat[3][3];
1201       float minx, maxx, miny, maxy;
1202       float timeofs, sizefac;
1203
1204       if (ob != NULL) {
1205         invert_m4_m4(imat, ob->obmat);
1206       }
1207       else {
1208         unit_m4(imat);
1209       }
1210       copy_m3_m4(imat3, imat);
1211
1212       copy_m3_m4(cmat, cu->textoncurve->obmat);
1213       mul_m3_m3m3(cmat, cmat, imat3);
1214       sizefac = normalize_v3(cmat[0]) / font_size;
1215
1216       minx = miny = 1.0e20f;
1217       maxx = maxy = -1.0e20f;
1218       ct = chartransdata;
1219       for (i = 0; i <= slen; i++, ct++) {
1220         if (minx > ct->xof) {
1221           minx = ct->xof;
1222         }
1223         if (maxx < ct->xof) {
1224           maxx = ct->xof;
1225         }
1226         if (miny > ct->yof) {
1227           miny = ct->yof;
1228         }
1229         if (maxy < ct->yof) {
1230           maxy = ct->yof;
1231         }
1232       }
1233
1234       /* we put the x-coordinaat exact at the curve, the y is rotated */
1235
1236       /* length correction */
1237       distfac = sizefac * cu->textoncurve->runtime.curve_cache->path->totdist / (maxx - minx);
1238       timeofs = 0.0f;
1239
1240       if (distfac > 1.0f) {
1241         /* path longer than text: spacemode involves */
1242         distfac = 1.0f / distfac;
1243
1244         if (cu->spacemode == CU_ALIGN_X_RIGHT) {
1245           timeofs = 1.0f - distfac;
1246         }
1247         else if (cu->spacemode == CU_ALIGN_X_MIDDLE) {
1248           timeofs = (1.0f - distfac) / 2.0f;
1249         }
1250         else if (cu->spacemode == CU_ALIGN_X_FLUSH) {
1251           distfac = 1.0f;
1252         }
1253       }
1254       else {
1255         distfac = 1.0;
1256       }
1257
1258       distfac /= (maxx - minx);
1259
1260       timeofs += distfac * cu->xof; /* not cyclic */
1261
1262       ct = chartransdata;
1263       for (i = 0; i <= slen; i++, ct++) {
1264         float ctime, dtime, vec[4], tvec[4], rotvec[3];
1265         float si, co;
1266
1267         /* rotate around center character */
1268         info = &custrinfo[i];
1269         ascii = mem[i];
1270         if (info->flag & CU_CHINFO_SMALLCAPS_CHECK) {
1271           ascii = towupper(ascii);
1272         }
1273
1274         che = find_vfont_char(vfd, ascii);
1275
1276         twidth = char_width(cu, che, info);
1277
1278         dtime = distfac * 0.5f * twidth;
1279
1280         ctime = timeofs + distfac * (ct->xof - minx);
1281         CLAMP(ctime, 0.0f, 1.0f);
1282
1283         /* calc the right loc AND the right rot separately */
1284         /* vec, tvec need 4 items */
1285         where_on_path(cu->textoncurve, ctime, vec, tvec, NULL, NULL, NULL);
1286         where_on_path(cu->textoncurve, ctime + dtime, tvec, rotvec, NULL, NULL, NULL);
1287
1288         mul_v3_fl(vec, sizefac);
1289
1290         ct->rot = (float)M_PI - atan2f(rotvec[1], rotvec[0]);
1291
1292         si = sinf(ct->rot);
1293         co = cosf(ct->rot);
1294
1295         yof = ct->yof;
1296
1297         ct->xof = vec[0] + si * yof;
1298         ct->yof = vec[1] + co * yof;
1299
1300         if (selboxes && (i >= selstart) && (i <= selend)) {
1301           EditFontSelBox *sb;
1302           sb = &selboxes[i - selstart];
1303           sb->rot = -ct->rot;
1304         }
1305       }
1306     }
1307   }
1308
1309   if (selboxes) {
1310     ct = chartransdata;
1311     for (i = 0; i <= selend; i++, ct++) {
1312       if (i >= selstart) {
1313         selboxes[i - selstart].x = ct->xof * font_size;
1314         selboxes[i - selstart].y = ct->yof * font_size;
1315       }
1316     }
1317   }
1318
1319   if (ELEM(mode, FO_CURSUP, FO_CURSDOWN, FO_PAGEUP, FO_PAGEDOWN) &&
1320       iter_data->status == VFONT_TO_CURVE_INIT) {
1321     ct = &chartransdata[ef->pos];
1322
1323     if (ELEM(mode, FO_CURSUP, FO_PAGEUP) && ct->linenr == 0) {
1324       /* pass */
1325     }
1326     else if (ELEM(mode, FO_CURSDOWN, FO_PAGEDOWN) && ct->linenr == lnr) {
1327       /* pass */
1328     }
1329     else {
1330       switch (mode) {
1331         case FO_CURSUP:
1332           lnr = ct->linenr - 1;
1333           break;
1334         case FO_CURSDOWN:
1335           lnr = ct->linenr + 1;
1336           break;
1337         case FO_PAGEUP:
1338           lnr = ct->linenr - 10;
1339           break;
1340         case FO_PAGEDOWN:
1341           lnr = ct->linenr + 10;
1342           break;
1343       }
1344       cnr = ct->charnr;
1345       /* seek for char with lnr en cnr */
1346       ef->pos = 0;
1347       ct = chartransdata;
1348       for (i = 0; i < slen; i++) {
1349         if (ct->linenr == lnr) {
1350           if ((ct->charnr == cnr) || ((ct + 1)->charnr == 0)) {
1351             break;
1352           }
1353         }
1354         else if (ct->linenr > lnr) {
1355           break;
1356         }
1357         ef->pos++;
1358         ct++;
1359       }
1360     }
1361   }
1362
1363   /* cursor first */
1364   if (ef) {
1365     float si, co;
1366
1367     ct = &chartransdata[ef->pos];
1368     si = sinf(ct->rot);
1369     co = cosf(ct->rot);
1370
1371     f = ef->textcurs[0];
1372
1373     f[0] = font_size * (-0.1f * co + ct->xof);
1374     f[1] = font_size * (0.1f * si + ct->yof);
1375
1376     f[2] = font_size * (0.1f * co + ct->xof);
1377     f[3] = font_size * (-0.1f * si + ct->yof);
1378
1379     f[4] = font_size * (0.1f * co + 0.8f * si + ct->xof);
1380     f[5] = font_size * (-0.1f * si + 0.8f * co + ct->yof);
1381
1382     f[6] = font_size * (-0.1f * co + 0.8f * si + ct->xof);
1383     f[7] = font_size * (0.1f * si + 0.8f * co + ct->yof);
1384   }
1385
1386   if (mode == FO_SELCHANGE) {
1387     MEM_freeN(chartransdata);
1388     chartransdata = NULL;
1389   }
1390   else if (mode == FO_EDIT) {
1391     /* make nurbdata */
1392     BKE_nurbList_free(r_nubase);
1393
1394     ct = chartransdata;
1395     for (i = 0; i < slen; i++) {
1396       unsigned int cha = (unsigned int)mem[i];
1397       info = &(custrinfo[i]);
1398
1399       if ((cu->overflow == CU_OVERFLOW_TRUNCATE) && (ob && ob->mode != OB_MODE_EDIT) &&
1400           (info->flag & CU_CHINFO_OVERFLOW)) {
1401         break;
1402       }
1403
1404       if (info->flag & CU_CHINFO_SMALLCAPS_CHECK) {
1405         cha = towupper(cha);
1406       }
1407
1408       if (ob == NULL || info->mat_nr > (ob->totcol)) {
1409         // CLOG_ERROR(
1410         //     &LOG, "Illegal material index (%d) in text object, setting to 0", info->mat_nr);
1411         info->mat_nr = 0;
1412       }
1413       /* We do not want to see any character for \n or \r */
1414       if (cha != '\n') {
1415         buildchar(cu, r_nubase, cha, info, ct->xof, ct->yof, ct->rot, i, font_size);
1416       }
1417
1418       if ((info->flag & CU_CHINFO_UNDERLINE) && (cha != '\n')) {
1419         float ulwidth, uloverlap = 0.0f;
1420         rctf rect;
1421
1422         if ((i < (slen - 1)) && (mem[i + 1] != '\n') &&
1423             ((mem[i + 1] != ' ') || (custrinfo[i + 1].flag & CU_CHINFO_UNDERLINE)) &&
1424             ((custrinfo[i + 1].flag & CU_CHINFO_WRAP) == 0)) {
1425           uloverlap = xtrax + 0.1f;
1426         }
1427         /* Find the character, the characters has to be in the memory already
1428          * since character checking has been done earlier already. */
1429         che = find_vfont_char(vfd, cha);
1430
1431         twidth = char_width(cu, che, info);
1432         ulwidth = (twidth * (1.0f + (info->kern / 40.0f))) + uloverlap;
1433
1434         rect.xmin = ct->xof;
1435         rect.xmax = rect.xmin + ulwidth;
1436
1437         rect.ymin = ct->yof;
1438         rect.ymax = rect.ymin - cu->ulheight;
1439
1440         build_underline(
1441             cu, r_nubase, &rect, cu->ulpos - 0.05f, ct->rot, i, info->mat_nr, font_size);
1442       }
1443       ct++;
1444     }
1445   }
1446
1447   if (iter_data->status == VFONT_TO_CURVE_SCALE_ONCE) {
1448     /* That means we were in a final run, just exit. */
1449     BLI_assert(cu->overflow == CU_OVERFLOW_SCALE);
1450     iter_data->status = VFONT_TO_CURVE_DONE;
1451   }
1452   else if (cu->overflow == CU_OVERFLOW_NONE) {
1453     /* Do nothing. */
1454   }
1455   else if ((tb_scale.h == 0.0f) && (tb_scale.w == 0.0f)) {
1456     /* Do nothing. */
1457   }
1458   else if (cu->overflow == CU_OVERFLOW_SCALE) {
1459     if ((cu->totbox == 1) && ((tb_scale.w == 0.0f) || (tb_scale.h == 0.0f))) {
1460       /* These are special cases, simpler to deal with. */
1461       if (tb_scale.w == 0.0f) {
1462         /* This is a potential vertical overflow.
1463          * Since there is no width limit, all the new lines are from line breaks. */
1464         if ((last_line != -1) && (lnr > last_line)) {
1465           const float total_text_height = lnr * linedist;
1466           iter_data->scale_to_fit = tb_scale.h / total_text_height;
1467           iter_data->status = VFONT_TO_CURVE_SCALE_ONCE;
1468         }
1469       }
1470       else if (tb_scale.h == 0.0f) {
1471         /* This is a horizontal overflow. */
1472         if (lnr > 1) {
1473           /* We make sure longest line before it broke can fit here. */
1474           float scale_to_fit = tb_scale.w / (longest_line_length);
1475           scale_to_fit -= FLT_EPSILON;
1476
1477           iter_data->scale_to_fit = scale_to_fit;
1478           iter_data->status = VFONT_TO_CURVE_SCALE_ONCE;
1479         }
1480       }
1481     }
1482     else {
1483       /* This is the really complicated case, the best we can do is to iterate over
1484        * this function a few times until we get an acceptable result.
1485        *
1486        * Keep in mind that there is no single number that will make all fit to the end.
1487        * In a way, our ultimate goal is to get the highest scale that still leads to the
1488        * number of extra lines to zero.
1489        */
1490       if (iter_data->status == VFONT_TO_CURVE_INIT) {
1491         bool valid = true;
1492
1493         for (int tb_index = 0; tb_index <= curbox; tb_index++) {
1494           TextBox *tb = &cu->tb[tb_index];
1495           if ((tb->w == 0.0f) || (tb->h == 0.0f)) {
1496             valid = false;
1497             break;
1498           }
1499         }
1500
1501         if (valid && (last_line != -1) && (lnr > last_line)) {
1502           const float total_text_height = lnr * linedist;
1503           float scale_to_fit = tb_scale.h / total_text_height;
1504
1505           iter_data->bisect.max = 1.0f;
1506           iter_data->bisect.min = scale_to_fit;
1507
1508           iter_data->status = VFONT_TO_CURVE_BISECT;
1509         }
1510       }
1511       else {
1512         BLI_assert(iter_data->status == VFONT_TO_CURVE_BISECT);
1513         /* Try to get the highest scale that gives us the exactly
1514          * number of lines we need. */
1515         bool valid = false;
1516
1517         if ((last_line != -1) && (lnr > last_line)) {
1518           /* It is overflowing, scale it down. */
1519           iter_data->bisect.max = iter_data->scale_to_fit;
1520         }
1521         else {
1522           /* It fits inside the textbox, scale it up. */
1523           iter_data->bisect.min = iter_data->scale_to_fit;
1524           valid = true;
1525         }
1526
1527         /* Bisecting to try to find the best fit. */
1528         iter_data->scale_to_fit = (iter_data->bisect.max + iter_data->bisect.min) * 0.5f;
1529
1530         /* We iterated enough or got a good enough result. */
1531         if ((!iter_data->iteraction--) || ((iter_data->bisect.max - iter_data->bisect.min) <
1532                                            (cu->fsize * FONT_TO_CURVE_SCALE_THRESHOLD))) {
1533           if (valid) {
1534             iter_data->status = VFONT_TO_CURVE_DONE;
1535           }
1536           else {
1537             iter_data->scale_to_fit = iter_data->bisect.min;
1538             iter_data->status = VFONT_TO_CURVE_SCALE_ONCE;
1539           }
1540         }
1541       }
1542     }
1543   }
1544
1545   /* Scale to fit only works for single text box layouts. */
1546   if (ELEM(iter_data->status, VFONT_TO_CURVE_SCALE_ONCE, VFONT_TO_CURVE_BISECT)) {
1547     /* Always cleanup before going to the scale-to-fit repetition. */
1548     if (r_nubase != NULL) {
1549       BKE_nurbList_free(r_nubase);
1550     }
1551
1552     if (chartransdata != NULL) {
1553       MEM_freeN(chartransdata);
1554     }
1555
1556     if (ef == NULL) {
1557       MEM_freeN((void *)mem);
1558     }
1559     return true;
1560   }
1561   else {
1562     ok = true;
1563   finally:
1564     if (r_text) {
1565       *r_text = mem;
1566       *r_text_len = slen;
1567       *r_text_free = (ef == NULL);
1568     }
1569     else {
1570       if (ef == NULL) {
1571         MEM_freeN((void *)mem);
1572       }
1573     }
1574
1575     if (chartransdata) {
1576       if (ok && r_chartransdata) {
1577         *r_chartransdata = chartransdata;
1578       }
1579       else {
1580         MEM_freeN(chartransdata);
1581       }
1582     }
1583
1584     /* Store the effective scale, to use for the textbox lines. */
1585     cu->fsize_realtime = font_size;
1586   }
1587   return ok;
1588
1589 #undef MARGIN_X_MIN
1590 #undef MARGIN_Y_MIN
1591 }
1592
1593 #undef DESCENT
1594 #undef ASCENT
1595
1596 bool BKE_vfont_to_curve_ex(Object *ob,
1597                            Curve *cu,
1598                            int mode,
1599                            ListBase *r_nubase,
1600                            const wchar_t **r_text,
1601                            int *r_text_len,
1602                            bool *r_text_free,
1603                            struct CharTrans **r_chartransdata)
1604 {
1605   VFontToCurveIter data = {
1606       .iteraction = cu->totbox * FONT_TO_CURVE_SCALE_ITERATIONS,
1607       .scale_to_fit = 1.0f,
1608       .ok = true,
1609       .status = VFONT_TO_CURVE_INIT,
1610   };
1611
1612   do {
1613     data.ok &= vfont_to_curve(
1614         ob, cu, mode, &data, r_nubase, r_text, r_text_len, r_text_free, r_chartransdata);
1615   } while (data.ok && ELEM(data.status, VFONT_TO_CURVE_SCALE_ONCE, VFONT_TO_CURVE_BISECT));
1616
1617   return data.ok;
1618 }
1619
1620 #undef FONT_TO_CURVE_SCALE_ITERATIONS
1621 #undef FONT_TO_CURVE_SCALE_THRESHOLD
1622
1623 bool BKE_vfont_to_curve_nubase(Object *ob, int mode, ListBase *r_nubase)
1624 {
1625   BLI_assert(ob->type == OB_FONT);
1626
1627   return BKE_vfont_to_curve_ex(ob, ob->data, mode, r_nubase, NULL, NULL, NULL, NULL);
1628 }
1629
1630 /** Warning: expects to have access to evaluated data
1631  * (i.e. passed object should be evaluated one...). */
1632 bool BKE_vfont_to_curve(Object *ob, int mode)
1633 {
1634   Curve *cu = ob->data;
1635
1636   return BKE_vfont_to_curve_ex(ob, ob->data, mode, &cu->nurb, NULL, NULL, NULL, NULL);
1637 }
1638
1639 /* -------------------------------------------------------------------- */
1640 /** \name VFont Clipboard
1641  * \{ */
1642
1643 static struct {
1644   wchar_t *text_buffer;
1645   CharInfo *info_buffer;
1646   size_t len_wchar;
1647   size_t len_utf8;
1648 } g_vfont_clipboard = {NULL};
1649
1650 void BKE_vfont_clipboard_free(void)
1651 {
1652   MEM_SAFE_FREE(g_vfont_clipboard.text_buffer);
1653   MEM_SAFE_FREE(g_vfont_clipboard.info_buffer);
1654   g_vfont_clipboard.len_wchar = 0;
1655   g_vfont_clipboard.len_utf8 = 0;
1656 }
1657
1658 void BKE_vfont_clipboard_set(const wchar_t *text_buf, const CharInfo *info_buf, const size_t len)
1659 {
1660   wchar_t *text;
1661   CharInfo *info;
1662
1663   /* clean previous buffers*/
1664   BKE_vfont_clipboard_free();
1665
1666   text = MEM_malloc_arrayN((len + 1), sizeof(wchar_t), __func__);
1667   if (text == NULL) {
1668     return;
1669   }
1670
1671   info = MEM_malloc_arrayN(len, sizeof(CharInfo), __func__);
1672   if (info == NULL) {
1673     MEM_freeN(text);
1674     return;
1675   }
1676
1677   memcpy(text, text_buf, len * sizeof(wchar_t));
1678   text[len] = '\0';
1679   memcpy(info, info_buf, len * sizeof(CharInfo));
1680
1681   /* store new buffers */
1682   g_vfont_clipboard.text_buffer = text;
1683   g_vfont_clipboard.info_buffer = info;
1684   g_vfont_clipboard.len_utf8 = BLI_wstrlen_utf8(text);
1685   g_vfont_clipboard.len_wchar = len;
1686 }
1687
1688 void BKE_vfont_clipboard_get(wchar_t **r_text_buf,
1689                              CharInfo **r_info_buf,
1690                              size_t *r_len_utf8,
1691                              size_t *r_len_wchar)
1692 {
1693   if (r_text_buf) {
1694     *r_text_buf = g_vfont_clipboard.text_buffer;
1695   }
1696
1697   if (r_info_buf) {
1698     *r_info_buf = g_vfont_clipboard.info_buffer;
1699   }
1700
1701   if (r_len_wchar) {
1702     *r_len_wchar = g_vfont_clipboard.len_wchar;
1703   }
1704
1705   if (r_len_utf8) {
1706     *r_len_utf8 = g_vfont_clipboard.len_utf8;
1707   }
1708 }
1709
1710 /** \} */