forked from unidoc/unioffice
-
Notifications
You must be signed in to change notification settings - Fork 0
/
paragraph.go
398 lines (350 loc) · 12.1 KB
/
paragraph.go
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
// Copyright 2017 FoxyUtils ehf. All rights reserved.
//
// Use of this source code is governed by the terms of the Affero GNU General
// Public License version 3.0 as published by the Free Software Foundation and
// appearing in the file LICENSE included in the packaging of this file. A
// commercial license can be purchased on https://unidoc.io.
package document
import (
"github.com/unidoc/unioffice/schema/soo/wml"
)
// Paragraph is a paragraph within a document.
type Paragraph struct {
d *Document
x *wml.CT_P
}
// X returns the inner wrapped XML type.
func (p Paragraph) X() *wml.CT_P {
return p.x
}
func (p Paragraph) ensurePPr() {
if p.x.PPr == nil {
p.x.PPr = wml.NewCT_PPr()
}
}
// RemoveRun removes a child run from a paragraph.
func (p Paragraph) RemoveRun(r Run) {
for _, c := range p.x.EG_PContent {
for i, rc := range c.EG_ContentRunContent {
if rc.R == r.x {
copy(c.EG_ContentRunContent[i:], c.EG_ContentRunContent[i+1:])
c.EG_ContentRunContent = c.EG_ContentRunContent[0 : len(c.EG_ContentRunContent)-1]
}
if rc.Sdt != nil && rc.Sdt.SdtContent != nil {
for i, rc2 := range rc.Sdt.SdtContent.EG_ContentRunContent {
if rc2.R == r.x {
copy(rc.Sdt.SdtContent.EG_ContentRunContent[i:], rc.Sdt.SdtContent.EG_ContentRunContent[i+1:])
rc.Sdt.SdtContent.EG_ContentRunContent = rc.Sdt.SdtContent.EG_ContentRunContent[0 : len(rc.Sdt.SdtContent.EG_ContentRunContent)-1]
}
}
}
}
}
}
// Properties returns the paragraph properties.
func (p Paragraph) Properties() ParagraphProperties {
p.ensurePPr()
return ParagraphProperties{p.d, p.x.PPr}
}
// Style returns the style for a paragraph, or an empty string if it is unset.
func (p Paragraph) Style() string {
if p.x.PPr != nil && p.x.PPr.PStyle != nil {
return p.x.PPr.PStyle.ValAttr
}
return ""
}
// SetStyle sets the style of a paragraph and is identical to setting it on the
// paragraph's Properties()
func (p Paragraph) SetStyle(s string) {
p.ensurePPr()
if s == "" {
p.x.PPr.PStyle = nil
} else {
p.x.PPr.PStyle = wml.NewCT_String()
p.x.PPr.PStyle.ValAttr = s
}
}
// AddRun adds a run to a paragraph.
func (p Paragraph) AddRun() Run {
pc := wml.NewEG_PContent()
p.x.EG_PContent = append(p.x.EG_PContent, pc)
rc := wml.NewEG_ContentRunContent()
pc.EG_ContentRunContent = append(pc.EG_ContentRunContent, rc)
r := wml.NewCT_R()
rc.R = r
return Run{p.d, r}
}
// Runs returns all of the runs in a paragraph.
func (p Paragraph) Runs() []Run {
ret := []Run{}
for _, c := range p.x.EG_PContent {
for _, rc := range c.EG_ContentRunContent {
if rc.R != nil {
ret = append(ret, Run{p.d, rc.R})
}
if rc.Sdt != nil && rc.Sdt.SdtContent != nil {
for _, rc2 := range rc.Sdt.SdtContent.EG_ContentRunContent {
if rc2.R != nil {
ret = append(ret, Run{p.d, rc2.R})
}
}
}
}
}
return ret
}
// InsertRunAfter inserts a run in the paragraph after the relative run.
func (p Paragraph) InsertRunAfter(relativeTo Run) Run {
return p.insertRun(relativeTo, false)
}
// InsertRunBefore inserts a run in the paragraph before the relative run.
func (p Paragraph) InsertRunBefore(relativeTo Run) Run {
return p.insertRun(relativeTo, true)
}
func (p Paragraph) insertRun(relativeTo Run, before bool) Run {
for _, c := range p.x.EG_PContent {
for i, rc := range c.EG_ContentRunContent {
if rc.R == relativeTo.X() {
r := wml.NewCT_R()
c.EG_ContentRunContent = append(c.EG_ContentRunContent, nil)
if before {
copy(c.EG_ContentRunContent[i+1:], c.EG_ContentRunContent[i:])
c.EG_ContentRunContent[i] = wml.NewEG_ContentRunContent()
c.EG_ContentRunContent[i].R = r
} else {
copy(c.EG_ContentRunContent[i+2:], c.EG_ContentRunContent[i+1:])
c.EG_ContentRunContent[i+1] = wml.NewEG_ContentRunContent()
c.EG_ContentRunContent[i+1].R = r
}
return Run{p.d, r}
}
if rc.Sdt != nil && rc.Sdt.SdtContent != nil {
for _, rc2 := range rc.Sdt.SdtContent.EG_ContentRunContent {
if rc2.R == relativeTo.X() {
r := wml.NewCT_R()
rc.Sdt.SdtContent.EG_ContentRunContent = append(rc.Sdt.SdtContent.EG_ContentRunContent, nil)
if before {
copy(rc.Sdt.SdtContent.EG_ContentRunContent[i+1:], rc.Sdt.SdtContent.EG_ContentRunContent[i:])
rc.Sdt.SdtContent.EG_ContentRunContent[i] = wml.NewEG_ContentRunContent()
rc.Sdt.SdtContent.EG_ContentRunContent[i].R = r
} else {
copy(rc.Sdt.SdtContent.EG_ContentRunContent[i+2:], rc.Sdt.SdtContent.EG_ContentRunContent[i+1:])
rc.Sdt.SdtContent.EG_ContentRunContent[i+1] = wml.NewEG_ContentRunContent()
rc.Sdt.SdtContent.EG_ContentRunContent[i+1].R = r
}
return Run{p.d, r}
}
}
}
}
}
return p.AddRun()
}
// AddHyperLink adds a new hyperlink to a parapgraph.
func (p Paragraph) AddHyperLink() HyperLink {
pc := wml.NewEG_PContent()
p.x.EG_PContent = append(p.x.EG_PContent, pc)
pc.Hyperlink = wml.NewCT_Hyperlink()
return HyperLink{p.d, pc.Hyperlink}
}
// AddBookmark adds a bookmark to a document that can then be used from a hyperlink. Name is a document
// unique name that identifies the bookmark so it can be referenced from hyperlinks.
func (p Paragraph) AddBookmark(name string) Bookmark {
pc := wml.NewEG_PContent()
rc := wml.NewEG_ContentRunContent()
pc.EG_ContentRunContent = append(pc.EG_ContentRunContent, rc)
relt := wml.NewEG_RunLevelElts()
rc.EG_RunLevelElts = append(rc.EG_RunLevelElts, relt)
markEl := wml.NewEG_RangeMarkupElements()
bmStart := wml.NewCT_Bookmark()
markEl.BookmarkStart = bmStart
relt.EG_RangeMarkupElements = append(relt.EG_RangeMarkupElements, markEl)
markEl = wml.NewEG_RangeMarkupElements()
markEl.BookmarkEnd = wml.NewCT_MarkupRange()
relt.EG_RangeMarkupElements = append(relt.EG_RangeMarkupElements, markEl)
p.x.EG_PContent = append(p.x.EG_PContent, pc)
bm := Bookmark{bmStart}
bm.SetName(name)
return bm
}
// AddFootnote will create a new footnote and attach it to the Paragraph in the
// location at the end of the previous run (footnotes create their own run within
// the paragraph). The text given to the function is simply a convenience helper,
// paragraphs and runs can always be added to the text of the footnote later.
func (p Paragraph) AddFootnote(text string) Footnote {
// ensure we use a proper IdAttr for the new footnote
var fnIDHeight int64
if p.d.HasFootnotes() {
for _, f := range p.d.Footnotes() {
if f.id() > fnIDHeight {
fnIDHeight = f.id()
}
}
fnIDHeight++
} else {
fnIDHeight = 0
p.d.footNotes = &wml.Footnotes{}
p.d.footNotes.CT_Footnotes = wml.CT_Footnotes{}
p.d.footNotes.Footnote = make([]*wml.CT_FtnEdn, 0)
}
// create a new footnote and footnote reference
fn := wml.NewCT_FtnEdn() // doc.footNotes.CT_Footnotes.Footnote[0]
fnRef := wml.NewCT_FtnEdnRef() // p.Runs()[0].X().EG_RunInnerContent[0].FootnoteReference
fnRef.IdAttr = fnIDHeight
// add new footnote to document
p.d.footNotes.CT_Footnotes.Footnote = append(p.d.footNotes.CT_Footnotes.Footnote, fn)
// Add the newly created footnote reference to a new run on the parent paragraph
run := p.AddRun()
runP := run.Properties()
runP.SetStyle("FootnoteAnchor")
run.x.EG_RunInnerContent = []*wml.EG_RunInnerContent{wml.NewEG_RunInnerContent()}
run.x.EG_RunInnerContent[0].FootnoteReference = fnRef
// formulate the new fnobject's inners
fnObj := Footnote{p.d, fn}
fnObj.x.IdAttr = fnIDHeight
fnObj.x.EG_BlockLevelElts = []*wml.EG_BlockLevelElts{wml.NewEG_BlockLevelElts()}
paraInner := fnObj.AddParagraph()
paraInner.Properties().SetStyle("Footnote")
paraInner.x.PPr.RPr = wml.NewCT_ParaRPr()
runInner := paraInner.AddRun()
runInner.AddTab()
runInner.AddText(text)
return fnObj
}
// RemoveFootnote removes a footnote from both the paragraph and the document
// the requested footnote must be anchored on the paragraph being referenced.
func (p Paragraph) RemoveFootnote(id int64) {
fns := p.d.footNotes
var i int
for i1, fn := range fns.CT_Footnotes.Footnote {
if fn.IdAttr == id {
i = i1
}
}
i = 0
fns.CT_Footnotes.Footnote[i] = nil
fns.CT_Footnotes.Footnote[i] = fns.CT_Footnotes.Footnote[len(fns.CT_Footnotes.Footnote)-1]
fns.CT_Footnotes.Footnote = fns.CT_Footnotes.Footnote[:len(fns.CT_Footnotes.Footnote)-1]
var r Run
for _, r1 := range p.Runs() {
if ok, fnID := r1.IsFootnote(); ok {
if fnID == id {
r = r1
}
}
}
p.RemoveRun(r)
}
// AddEndnote will create a new endnote and attach it to the Paragraph in the
// location at the end of the previous run (endnotes create their own run within
// the paragraph. The text given to the function is simply a convenience helper,
// paragraphs and runs can always be added to the text of the endnote later.
func (p Paragraph) AddEndnote(text string) Endnote {
// ensure we use a proper IdAttr for the new endnote
var enIDHeight int64
if p.d.HasEndnotes() {
for _, f := range p.d.Endnotes() {
if f.id() > enIDHeight {
enIDHeight = f.id()
}
}
enIDHeight++
} else {
enIDHeight = 0
p.d.endNotes = &wml.Endnotes{}
}
// create a new endnote and endnote reference
en := wml.NewCT_FtnEdn() // doc.endNotes.CT_Endnotes.Endnote[0]
enRef := wml.NewCT_FtnEdnRef() // p.Runs()[0].X().EG_RunInnerContent[0].EndnoteReference
enRef.IdAttr = enIDHeight
// add new endnote to document
p.d.endNotes.CT_Endnotes.Endnote = append(p.d.endNotes.CT_Endnotes.Endnote, en)
// Add the newly created endnote reference to a new run on the parent paragraph
run := p.AddRun()
runP := run.Properties()
runP.SetStyle("EndnoteAnchor")
run.x.EG_RunInnerContent = []*wml.EG_RunInnerContent{wml.NewEG_RunInnerContent()}
run.x.EG_RunInnerContent[0].EndnoteReference = enRef
// formulate the new enobject's inners
enObj := Endnote{p.d, en}
enObj.x.IdAttr = enIDHeight
enObj.x.EG_BlockLevelElts = []*wml.EG_BlockLevelElts{wml.NewEG_BlockLevelElts()}
paraInner := enObj.AddParagraph()
paraInner.Properties().SetStyle("Endnote")
paraInner.x.PPr.RPr = wml.NewCT_ParaRPr()
runInner := paraInner.AddRun()
runInner.AddTab()
runInner.AddText(text)
return enObj
}
// RemoveEndnote removes a endnote from both the paragraph and the document
// the requested endnote must be anchored on the paragraph being referenced.
func (p Paragraph) RemoveEndnote(id int64) {
ens := p.d.endNotes
var i int
for i1, en := range ens.CT_Endnotes.Endnote {
if en.IdAttr == id {
i = i1
}
}
i = 0
ens.CT_Endnotes.Endnote[i] = nil
ens.CT_Endnotes.Endnote[i] = ens.CT_Endnotes.Endnote[len(ens.CT_Endnotes.Endnote)-1]
ens.CT_Endnotes.Endnote = ens.CT_Endnotes.Endnote[:len(ens.CT_Endnotes.Endnote)-1]
var r Run
for _, r1 := range p.Runs() {
if ok, enID := r1.IsEndnote(); ok {
if enID == id {
r = r1
}
}
}
p.RemoveRun(r)
}
// SetNumberingLevel sets the numbering level of a paragraph. If used, then the
// NumberingDefinition must also be set via SetNumberingDefinition or
// SetNumberingDefinitionByID.
func (p Paragraph) SetNumberingLevel(listLevel int) {
p.ensurePPr()
if p.x.PPr.NumPr == nil {
p.x.PPr.NumPr = wml.NewCT_NumPr()
}
lvl := wml.NewCT_DecimalNumber()
lvl.ValAttr = int64(listLevel)
p.x.PPr.NumPr.Ilvl = lvl
}
// SetNumberingDefinition sets the numbering definition ID via a NumberingDefinition
// defined in numbering.xml
func (p Paragraph) SetNumberingDefinition(nd NumberingDefinition) {
p.ensurePPr()
if p.x.PPr.NumPr == nil {
p.x.PPr.NumPr = wml.NewCT_NumPr()
}
lvl := wml.NewCT_DecimalNumber()
numID := int64(-1)
for _, n := range p.d.Numbering.x.Num {
if n.AbstractNumId != nil && n.AbstractNumId.ValAttr == nd.AbstractNumberID() {
numID = n.NumIdAttr
}
}
if numID == -1 {
num := wml.NewCT_Num()
p.d.Numbering.x.Num = append(p.d.Numbering.x.Num, num)
num.NumIdAttr = int64(len(p.d.Numbering.x.Num))
num.AbstractNumId = wml.NewCT_DecimalNumber()
num.AbstractNumId.ValAttr = nd.AbstractNumberID()
}
lvl.ValAttr = numID
p.x.PPr.NumPr.NumId = lvl
}
// SetNumberingDefinitionByID sets the numbering definition ID directly, which must
// match an ID defined in numbering.xml
func (p Paragraph) SetNumberingDefinitionByID(abstractNumberID int64) {
p.ensurePPr()
if p.x.PPr.NumPr == nil {
p.x.PPr.NumPr = wml.NewCT_NumPr()
}
lvl := wml.NewCT_DecimalNumber()
lvl.ValAttr = int64(abstractNumberID)
p.x.PPr.NumPr.NumId = lvl
}